-
Notifications
You must be signed in to change notification settings - Fork 0
Workflow for new functions
Denny Wang edited this page Aug 23, 2023
·
10 revisions
To add new function to the ihmeuw-demographics
packages, a developer should follow these steps:
- Create a git feature branch for your additions
- Open the
.Rproj
file to enter a Rstudio workspace for editing the package. For more information on R projects go here. - Create a new
.R
file in theR
directory - Write out your function with complete documentation and according to our style guide.
- Create and run tests, debug as needed.
- Optional: create a vignette to describe your function (or related functions), when you would use it, and some context or examples.
- Knit the documentation (
devtools::document()
). - Check the package (
devtools::check()
orBuild > Check Package
).- Goal: 0 errors, 0 warnings, 0 notes
- The package check includes all tests, including testing that function examples work, spell-check, formatting, and more
- Submit a pull request on github.
- Get at least 1 approval, and repeat any of the above steps as appropriate.
- Merge your PR into the master branch. This will trigger the github action checks and evaluation of test coverage. The pkgdown site will also be automatically updated.
Propagate changes todocker-base
and/ordocker-internal
.