Skip to content

What needs to be updated from the template for each new package?

Charlton Callender edited this page May 1, 2020 · 1 revision

After using this package as a template for a new package there are a couple of things to change for the new package

Package title and description

Create a unique and informative title and description for the new package. This information needs to be updated in the DESCRIPTION, README.md, and packageTemplate.R files.

Package authors

Update the relevant authors for this new package in the DESCRIPTION file.

pkgdown url

Update the pkgdown url in the DESCRIPTION, README.md and github home page for the repo.

  • The url will be https://ihmeuw-demographics.github.io/NEW_REPO/

  • This site will be automatically rebuilt with every push to the master branch using github actions.

  • The site can always be previewed locally by running pkgdown::build_site()

Search for any other package imports/references

In Rstudio Edit -> Find in Files -> "packageTemplate"