Collects information from the headers of the README files in model directories and returns the results as a data frame
Usage
mp_show_models(
dir = system.file("starter_models", package = "macpan2"),
show_missing = FALSE,
for_markdown = FALSE
)
show_models(
dir = system.file("starter_models", package = "macpan2"),
show_missing = FALSE,
for_markdown = FALSE
)
mp_list_models(dir = system.file("starter_models", package = "macpan2"))
Value
a data frame containing entries Directory
(model directory), Title
(model title), Description
(short description)
Functions
show_models()
: Synonym formp_show_models
, which is preferred. Present for back-compatibility.mp_list_models()
: Return a character vector containing model names, instead of a data frame with more information about each model.
Examples
mp_show_models(show_missing = TRUE)
#> Directory Title
#> 1 awareness Awareness Models
#> 2 fibonacci Fibonacci Numbers
#> 3 hiv HIV
#> 4 lotka_volterra_competition Lotka-Volterra
#> 5 lotka_volterra_predator_prey Lotka-Volterra
#> 6 macpan_base Macpan Base
#> 7 nfds NFDS and Vaccine Design
#> 8 seir Basic SEIR
#> 9 shiver SHIVER = SEIR + H + V
#> 10 si Basic SI
#> 11 sir Basic SIR
#> 12 sir_age Age-stratified SIR
#> 13 sir_demog SIR with Demography
#> 14 sir_mosquito Mosquito-Vector SIR
#> 15 sir_waning SIR with Waning Immunity (SIRS)
#> 16 ww Wastewater Model
#> Description
#> 1 Behaviour modifications in response to death
#> 2 Matrix population model for generating the Fibonacci numbers
#> 3 A simple HIV model
#> 4 Simple two-species competition model
#> 5 Simple predator-prey model
#> 6 Re-implementation of the McMaster group's COVID-19 model
#> 7 An ecological model using population genomics to design optimal vaccines as implemented in Colijn et al. (2020)
#> 8 Simple epidemic model with an exposed class
#> 9 A modified SEIR model with Hospitalization and Vaccination
#> 10 A very simple epidemic model
#> 11 A very simple epidemic model
#> 12 An age-stratified SIR model
#> 13 An SIR model with birth and death
#> 14 SIR model for mosquito vectors
#> 15 A basic SIR model with a flow from R back to S
#> 16 Macpan base with an additional wastewater component