benmarwick / rrtools

rrtools: Tools for Writing Reproducible Research in R
Other
671 stars 85 forks source link

Docum. is outdated: update README: usethis::use_mit_license() #44

Closed knbknb closed 6 years ago

knbknb commented 6 years ago

This is only a tiny problem, too small for a pull request.

The documentation/README.md seems to be outdated here.

Please consider updating the README.md file:

usethis::use_mit_license(copyright_holder = "my name")

Error in usethis::use_mit_license(copyright_holder = "my name") : 
  unused argument (copyright_holder = "my name")

With

usethis::use_mit_license(name = "My Name")

Result:

✔ Setting License field in DESCRIPTION to 'MIT + file LICENSE' ✔ Writing 'LICENSE.md' ✔ Adding '^LICENSE\.md$' to '.Rbuildignore' ✔ Writing 'LICENSE'

I also think step 3 (devtools::use_github(...)) should be marked as optional, maybe in a subtle way. Uploading the repo to github early might pollute the github account with incomplete repositories and package stubs. This is just my personal opinion.

Also, a bulletpoint could be added (to step 3) that all subtasks of step 1 must be completed otherwise the uploader will croak.

topic 5 contains a typo:

"vingettes" to create a "vingettes/"

(the rrtools::use_analysis( location = "vignettes") call works properly, though)