CONTRIBUTING.md

In Big-Life-Lab/recodeflow: Contains functions to interface with variable details sheets, including recoding variables and converting them to PMML

Contributing to recodeflow

Installation

1. Install R

This package uses R version 4.3.2. If you have another version of R installed on your system, we recommend using rig which allows you to install and manage multiple versions of R. Use the commands rig add 4.3.2 and rig default 4.3.2 to install and use the required R version. 2. Install dependencies

This package uses renv to manage its dependencies. Start an R session within the project root and renv should bootstrap itself. You can then run the command renv::restore() to install the dependencies.

You should now be ready to start working on the package

Running tests

Install the dependencies

Run the command devtools::test() within the R session to run the tests.

Filing an issue

The easiest way to propose a change or new feature is to file an issue. If you've found a bug, you may also create an associated issue. If possible, try to illustrate your proposal or the bug with a minimal reproducible example. When filing an issue, please use the issues template available on the GitHub repository.

Pull request

• Please create a Git branch for each pull request (PR). Click here for information on how to create a PR.
• Your contributed code should roughly follow the tidyverse style guide.
• recodeflow uses roxygen2, with Markdown syntax, for documentation.
• recodeflow uses testthat. Adding tests to the PR makes merging the PR into the code base less prone to bugs.
• If your PR is a user-visible change, you may add a bullet to the top of NEWS.md describing the changes made. You may optionally add your GitHub username, and links to relevant issue(s)/PR(s).

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Big-Life-Lab/recodeflow documentation built on April 3, 2025, 2:02 p.m.