Skip to contents

Contributing to spacc

Source: CONTRIBUTING.md

Code of conduct

Participation in this project follows CODE_OF_CONDUCT.md.

Setup

Clone the repository and install the development dependencies from R:

pak::pak(c("devtools", "testthat", "rcmdcheck", "roxygen2"))
devtools::install_deps(dependencies = TRUE)

Testing

Run the test suite and package check before opening a pull request:

devtools::test()
devtools::check()

Changes to statistical methods need tests against independently calculated reference values. Changes to estimators need parameter-recovery or interval- coverage tests using simulated data with known truth.

Documentation

Document exported functions with roxygen2 and regenerate the package files:

devtools::document()

Update the relevant vignette and NEWS.md when behavior visible to users changes.

Project organization

  • R/ contains the R interface and S3 methods.
  • src/ contains the compiled accumulation kernels.
  • tests/testthat/ contains unit, reference, recovery, and coverage tests.
  • vignettes/ contains worked documentation.
  • paper/ contains the manuscript and its figures.

Pull requests

  1. Create a focused branch.
  2. Add the implementation and tests in the same change.
  3. Run devtools::test() and devtools::check().
  4. Regenerate documentation when public interfaces change.
  5. Describe the behavior change and the evidence supporting it.

Contributions are licensed under the project license when merged.