Skip to content

Instantly share code, notes, and snippets.

@benzipperer
Last active January 31, 2025 21:26
Show Gist options
  • Save benzipperer/9b16cf0575cada6c8f119a6b62510cc3 to your computer and use it in GitHub Desktop.
Save benzipperer/9b16cf0575cada6c8f119a6b62510cc3 to your computer and use it in GitHub Desktop.
instructions to build the realtalk package https://economic.github.io/realtalk/

realtalk R package build instructions

Requirements

Update frequency

monthly, upon BLS CPI release

Update instructions

  1. Change download_date and run targets::tar_make()
  2. Update DESCRIPTION with new version number and modify NEWS.md
  3. Confirm updated data:
    1. Load package locally via devtools::load_all() (CTRL-SHIFT-L) and confirm available_price_indices contains updated data
    2. Confirm latest values of cpi_u_monthly_sa and pce_monthly_sa are correct
  4. Build package locally and update readme:
    1. Use R CMD INSTALL and load installed package: CTRL-SHIFT-B
    2. Create updated README.md by knitting README.Rmd (CTRL-SHIFT-K)
    3. Confirm available_price_indices example in README.md is updated
  5. Confirm package passes devtools::check() with no errors or warnings
  6. Commit changes and push to github
  7. Confirm the package website is correctly updated
  8. Publish a new "release" on Github, assigning the tag "vX.Y.Z" corresponding to the new version X.Y.Z

Confirm public updates

  1. Wait a few minutes and confirm successful package website update: https://economic.github.io/realtalk/
  2. In a few hours confirm new version is available via r-universe: https://economic.r-universe.dev/realtalk
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment