This page outlines how to contribute to the
Adding variables to cchsflow
Transforming existing CCHS variables
Using the naming conventions described in the
variable_details.csv you can add more CCHS variables that can be transformed and harmonized across cycles.
Creating a derived variable
You will first need to create a custom function that will carry out the necessary transformations needed for your derived variable. You will then need to specify your derived variable on
variable_details.csv. For more information, click here.
Requesting a variable
To request a variable to be added to cchsflow, please use the variable request template available on the GitHub repository.
Linking to Images
When linking to images in .Rmd files, make sure to add the relative path to the image in the resource_files section of the .Rmd file. An example is given below,
Linking to other .Rmd files
When linking to other .Rmd files make sure their extension is changed to .html. This ensures that the links continue to work when they are converted to the pkgdown site
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.
- 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.
- cchsflow uses roxygen2, with Markdown syntax, for documentation.
- cchsflow 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.