Contributing • CAMDAC

To contribute to CAMDAC, fork the repository and install the development dependencies with remotes::install_dev_deps('.').

After making your changes, run the test and build commands listed below, then submit a pull request with the changes on your fork.

CAMDAC test and build commands

library(devtools)

# Install dev dependencies
devtools::install_dev_deps("VanLoo-lab/CAMDAC")

# Update docs
devtools::document()

# Run tests
devtools::test()

# Build readme
rmarkdown::render('README.Rmd', output_format='github_document', output_file='README.md')

# Check package builds
devtools::check()

# Build documentation
pkgdown::build_site(examples=FALSE, devel=TRUE, lazy=TRUE, preview=FALSE)
pkgdown::preview_site() # To view. Or: python3 -m http.server --directory docs 8000

# Commit changes on the docs/ folder before submitting