Contributions of various forms are welcome:
- a correction to an existing package or model description
- a new type of model that isn't already documented or a sub-type of an existing section
- a new package that isn't already mentioned
- full details of any of the packages mentioned in the "Other packages to explore but not detailed here" sections
- Fork this repo
- Install hugo
- Add or update content (see below for details on content templates.)
- Open a pull request from your fork into master of this repo. Netlify will run some automated checks on your pull request and allow you to see a deploy preview with the changes.
- If you are fixing an existing issue, in the pull request description please link the issue using keyword in the pull request description so that it will be automatically updated; see https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
All model and package documentation lives in the content/docs directory. This directory has a tree structure,
e.g.
state-transition-models ├── markov-models
| └── _index.md
├── decision-trees
| └── _index.md
└── _index.md
To add a new section you will first add a new directory or sub-directory, and then a new documentation page inside
the new directory.
Documentation can either be a normal
Markdown or an RMarkdown document
and it must be named either _index.md or _index.Rmd, respectively. Where possible, i.e. if your content does not
contain any chunks of R code, use regular markdown.
All _index.md and _index.Rmd files should adhere to the templates provided in the
templates folder.
Important: if using an .Rmd file please knit it locally and commit both the .Rmd, the compiled .md and any generated files which should appear in the ./static folder
-
if using RMarkdown, knit any new .Rmd files to .md files first
-
serve the site locally by running from the command line:
hugo serve