Repository navigation
create_tidy_package() to create public package with tidyverse/r-lib convensions #461
Description
I am not sure if this is possible to do in one go, as the user might need to edit files, or maybe run git between the steps, we'll see. Order might change later.
create_package()use_tidy_description()- Add empty
R/package.Rfile use_git()use_github()use_testthat()- Add empty
tests/testthat/test.Rfile. use_mit_license()use_readme_rmd()use_news_md()use_tidy_ci()use_appveyor()use_tidy_contributing()use_tidy_coc()use_lifecycle_badge()use_roxygen_md()use_cran_badge()use_coverage()- Knit
README.md - Add all newly created files to git, commit, push.
The badges can be part of some use_tidy_readme_rmd(), because currently they need manual copy and paste.
Activity
gaborcsardi commentedon Sep 12, 2018
Just tried it, mostly works. Some steps are manual, we can fix that with a tidy README.Rmd template.
jennybc commentedon Sep 12, 2018
I think this might be best as a "doctor" or reporting function, i.e. it reports how much of this has been done and reminds of relevant functions for the un-done parts.
gaborcsardi commentedon Sep 12, 2018
That would be great as well, but I would very much like a version that just did everything....
hadley commentedon Sep 12, 2018
I guess I tend to run them more over time - i.e. I don't run
use_test()until I write the first test, and I don't runuse_news_md()until after the first release. But I don't have any objection to setting up from the very beginning.jennybc commentedon Sep 12, 2018
Perhaps the point is that is should be very resilient to re-application, i.e. it does something sensible de novo but can also cope when the work is partially done.
hadley commentedon Sep 12, 2018
Yeah, and ideally you should be able to run it on a package that you created two years ago and bring it up to spec for today.
gaborcsardi commentedon Sep 12, 2018
Yeah, some things you can do on demand, like tests. But others I just tend to forget sometimes...
hadley commentedon Nov 24, 2018
See also the checklist: tidyverse/readxl#241 (comment)
hadley commentedon Nov 29, 2018
I think we need two pieces:
create_tidy_package()which callscreate_package()and then the functions listed aboveuse_tidy_standards(cur = "1.0.0")which would create an issue checklist with the new functions you need to run.