DEVELOPMENT.md

orcidtr: Development Quick Reference

Common R Package Tasks

Document functions:

devtools::document()

Build README.md from README.Rmd:

devtools::build_readme()

Run all tests:

devtools::test()

Check package:

devtools::check()

Install package locally:

devtools::install()

Build source tarball:

devtools::build()

Update version: Edit DESCRIPTION file, then update NEWS.md.

Tag release:

git tag -a vX.Y.Z -m "Release vX.Y.Z"
git push origin vX.Y.Z

Check before commit:

devtools::document(); devtools::test(); devtools::check(); devtools::build_readme()

CRAN submission (summary):

1. Update version, NEWS.md, cran-comments.md
2. devtools::check(cran = TRUE)
3. rhub::check_for_cran()
4. devtools::spell_check()
5. urlchecker::url_check()
6. devtools::build()
7. devtools::submit_cran()

Help:

?function_name

Website docs:

altdoc::render_docs()

Install from GitHub:

remotes::install_github("lorenzoFabbri/orcidtr")

See README.md for more details.