bsyncr

A package for generating BuildingSync documents in R. It is intended to be used in parallel with the nmecr package, enabling serialization of NMEC analysis into BuildingSync documents.

Using as a package

Go to NOAA's website to request an API key. This is needed to look up weather data. Set an environment variable named NOAA_TOKEN with your API key.

export NOAA_TOKEN=YOUR_KEY_HERE

Within R, run the following to test if the package loads. There are many dependent packages that might need to be installed, check the logs as needed.

remotes::install_github('BuildingSync/bsyncr', upgrade='never')

# using a specific release
remotes::install_github('BuildingSync/[email protected]', upgrade='never')

# verify that the package loads
library(bsyncr)

# see the vignette PDF file or the test file for an
# example on using.

Testing

Tests are automatically run on GitHub. To run locally, make sure to have R installed along with various dev packages.

Rscript setup_environment.R
Rscript -e "testthat::test_dir('tests')"

Releasing new version

• Open bysync.Rproj in RStudio
• In RStudio, format all the R files by running the following commands in RStudio

install.packages("styler", repos = "http://cran.us.r-project.org")
styler::style_dir()

• Create a branch with the prepared release change log.
• For testing purposes, make sure the versions of NMECR and RNOAA are correct in the setup_environment.R script
• Update version in DESCRIPTION to the next correct semantic version
• Make sure the DESCRIPTION has the correct version of the dependencies
• Create CHANGELOG in GitHub, paste in updates into CHANGELOG.md
• Run pre-commit locally
• Merge release prep PR to develop
• Test as needed
• To release, from the command line merge latest develop into latest main: git merge --ff-only origin develop. This will point the HEAD of main to latest develop. Then push the main branch to GitHub with git push, which may require a developer with elevated privileges to push to main.
• Back on GitHub create a new tag in GitHub against main and copy the change log notes into the tag description.
• Tag on GitHub, copy over the correct version (format vX.Y.Z) and CHANGELOG content.

TODO

• Stub out auc:DerivedModels for both the baseline and reporting scenarios
• Run NMEC analysis, as shown in nmecr vignette
  • Serialize the SLR model
  • Serialize the 5p change point model
• Add timeseries serialization into utility functions