PEDSnet Reusable Code Repo Template

PEDSnet Reusable Code Repo Template is a blank GitHub repository and README template for reusable code submitted to PEDSpace for ingestion. The BLANK_README template is stripped-down fork of the Best-README-Template. We ask that you minimally include the information outlined in this document.

How To Use This Template

1. "Use this Template" in GitHub under the PEDSnet organization¹.
2. Open BLANK_README.md.
3. Change or add any images that best describe your project².
4. Find and replace the following placeholders:
   • repo_name: The repository name in snake_case format (e.g., my_project_repo). This must correspond to the repo name in the GitHub repo's URL.
   • project_title: A human-readable, Title Case name for your project (e.g., "My Project Title").
   • project_description: A concise description of your project (1-2 sentences).
   • project_license: The license type for your project (e.g., MIT, GPL-3.0).
5. Update LICENSE.txt to reflect your submission's copyright license.
6. Follow the instructions under Reproducibility.
7. Delete this README.md and rename BLANK_README.md to README.md.
8. Commit and push to origin/main.

Reproducibility

If you are doing ongoing R development work, we strongly encourage that you do so using renv e.g. renv::init() and renv::snapshot(). This will make not only documentation easier but can also improve your development workflow in the long run by ensuring version consistency and improving reproducibility.

Below are the minimum submission guidelines:

Required

• Code Repositories (not packaged):
  • Must include an renv.lock file generated from the most up-to-date R environment capabale of successfully executing the code.
• Packaged Repositories:
  • renv.lock file is optional but must document:
    • R version used for development.
    • Key dependency versions³.

Optional

• Use an renv project library for version consistency and improved development workflow.

Steps:

1. Make sure that the project root is the working directory of your R session e.g setwd('/path/to/project/dir').
2. Generate the renv.lock file:

   renv::snapshot()

3. To restore the R environment:

   renv::restore()

Footnotes

1. Click on the "Use this Template" button in the corner of the page to create a repository using this template, and then clone this repository locally to edit. I recommend VSCode with the Markdown Preview Enanched extension, but you can also use a plaintext text editor. ↩

2. Swap out images/screenshot.png with a relevant image for your deposit (optional) and uncomment and edit lines 25 and 26 in to display it. ↩

3. If you are submitting a package without an renv.lock file, you can use utils::sessionInfo() or (preferably) sessioninfo::session_info(pkgs = "attached") from the sessioninfo package to generate an output to include under the Built With section of the template. ↩