https://github.com/big-life-lab/model-parameters
Repository of templates required for model publication and/or implementation
https://github.com/big-life-lab/model-parameters
Last synced: 21 days ago
JSON representation
Repository of templates required for model publication and/or implementation
- Host: GitHub
- URL: https://github.com/big-life-lab/model-parameters
- Owner: Big-Life-Lab
- Created: 2020-11-05T14:37:54.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-06-23T13:08:36.000Z (about 1 month ago)
- Last Synced: 2026-06-23T15:06:38.068Z (about 1 month ago)
- Language: R
- Homepage: https://big-life-lab.github.io/model-parameters/
- Size: 539 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# model-parameters-template
This repo provides a template for all current model parameter documents. The goal is to describe the model and outline all the steps to go from the starting variables in the model to calculating the outcome of the model. These files provide a transparent, detailed description of the model for publication and/or implementation. See https://big-life-lab.github.io/model-parameters/ for more details.
## Setup
### Installing Dependencies
This project uses [renv](https://rstudio.github.io/renv/) for R dependency
management. To set up the development environment:
1. Open R in the project directory (renv will automatically activate)
2. Install all required dependencies:
```r
renv::restore()
```
## Documentation
The `docs/` directory contains the Quarto project for the model parameter
documentation website. This includes all the source files (.qmd),
configuration (_quarto.yml), and supporting assets needed to build and deploy
the documentation. The documentation is automatically built and deployed to
GitHub Pages when changes are pushed to the main branch.
## Changing files
Before updating any files in the project make sure to first read and follow
the rules in the README.md files of the containing and parent folders. For
example, when modifying files in the `inst/metadata` folder you should follow
the rules in the README.md files in the `inst/metadata` folder, the `inst`
folder, and the project root folder.