Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

usethis issue clinic #27

Open
tjmahr opened this issue Mar 7, 2019 · 4 comments
Open

usethis issue clinic #27

tjmahr opened this issue Mar 7, 2019 · 4 comments

Comments

@tjmahr
Copy link

tjmahr commented Mar 7, 2019

I love the usethis package. It lets you set up common pieces of R projects using standardized templates. Want to add a unit test a package? usethis::use_test() will create a file in tests/testthat and open it in RStudio for you. usethis::use_logo() will take an image file, resize it and store it man/figures/logo.png, which is a good spot for a logo file in an R package.

I see two routes here.

1. We show the package some care and try to take out some issues with one of the package's contributer's onsite as a coach (Jim Hester)

2. usethis is geared towards package developers, so we think about what pieces of boilerplate we would want to automate as data analysts. For example, use_database(connection) would create the configuration files needed to manage a database connection, add them to .gitignore, etc.

The main limitations for this proposal I think are that

  • This would be developing and improving tools instead of making something new and cool.
  • We don't own the package so our suggestions for new features could be ruled out by RStudio people.
@wlandau
Copy link

wlandau commented Mar 7, 2019

We might also look at the starters package.

On a different note, a use_drake() function has been requested (ref: ropensci/drake#761 (comment)). I am thinking it could set up some simple files described here with example code included but commented out (example file structure: https://github.com/wlandau/drake-examples/tree/master/main). I am not sure whether such a function should go in drake, starters, or usethis.

@emilyriederer
Copy link
Collaborator

Given that drake would have to be installed for use_drake() to be useful, maybe it would make sense to put it in drake and then both starters and usethis could add their own wrappers calling it? (Similar to how devtools is now calling from a family of package development packages)

@wlandau
Copy link

wlandau commented Mar 8, 2019

Sounds reasonable. Just opened ropensci/drake#773.

@jdblischak
Copy link

usethis is geared towards package developers, so we think about what pieces of boilerplate we would want to automate as data analysts.

@tjmahr You may also be able to get some ideas from the rrtools package, which has e.g. use_analysis().

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants