reminders.RdPrint out a list of steps to take upon creating a new R package in RStudio.
reminders(pkg = basename(getwd()), account = "leonawicz")
| pkg | defaults to working directory. |
|---|---|
| account | GitHub account name, defaults to "leonawicz". |
cat a list of steps to the console.
Adding the repo on GitHub (step 3) can be done any time prior to step 4.
The suggested steps are mostly universal except for the final two, which cater to SNAPverse defaults.
See use_these for details on defaults.
reminders()#> 1. Create a new R package via RStudio > New Project > R Package #> with 'Create a git repository' checked. #> 2. Make initial commit by adding the initial .Rbuildignore, .gitignore and [pkgname].Rproj files. #> 3. Add the repo on GitHub: #> Use default settings (Do not create README.md). #> Set docs/ directory for hosting project website (Must first push docs/ to GitHub). #> 4. In git shell, enter: #> git remote add origin git@github.com:leonawicz/reference.git #> git push -u origin master #> 5. Then return to R console and run: #> snapmeta::use_these() #> NOTE: Run Rstudio session as Administator in Windows so usethese() can create lintr symbolic link. #> 6. Add Travis CI, Appveyor and code coverage badges to README.Rmd. Add projects on respective sites. #> Badges are in console output. Remember to add the `after_success` segment to .travis.yml as well. #> 7. Check the following: #> Delete absolute path to `docs` created by pkgdown in .Rbuildignore. #> Make initial updates to DESCRIPTION and other files, e.g., README.Rmd, vignette Rmd file, LICENSE.md. #> Delete NAMESPACE so it can be auto-generated via devtools. #> Delete any Hello World files. #> At least one inital unit test is required to pass build. Lintr test will suffice. #> Commit changes, but hold off on cran-comments.md and revdep until meaningful.