vignettes/README.md

In mrc-ide/naomi: Naomi Model for Subnational HIV Estimates

Vignettes

Vignettes in this directory are generated by make, if you want to edit the vignettes edit the source files in src. The source files are vignettes_src/data-model.Rmd vignettes_src/model-workflow.R

Use make vignettes to generate make. This will:

• Run vignettes/script/create_data_model.R to produce vignettes/figure/data_model.png
• Copy vignettes_src/data-model.Rmd to data-model.Rmd
• Spin vignettes_src/model-workflow.R to vignettes_src/model-workflow.Rmd
• Knit vignettes_src/model-workflow.Rmd to vignettes_src/model-workflow.md and a folder of figures
• Copy vignettes_src/model-workflow.md and vignettes_src/figure directory to model-workflow.Rmd and figure respectively
• Knit data-model.Rmd and model-workflow.Rmd the latter of which has no executable code

We do it this way as travis was having problems running the model-workflow vignette so we knit this locally and build the version on travis without any executable code.

mrc-ide/naomi documentation built on April 10, 2024, 2:13 p.m.