Skip to content

Commit

Permalink
There are a few parameter documentation things I think it would be go…
Browse files Browse the repository at this point in the history
…od to tidy up. First, n_severe isn't a prevalence output (model.R). I've reorganised the parameter documentation list into an order I think is a bit more intuitive, with consistency between code and documentation.
  • Loading branch information
RJSheppard committed May 2, 2024
1 parent 1111500 commit da95b18
Show file tree
Hide file tree
Showing 4 changed files with 332 additions and 292 deletions.
13 changes: 5 additions & 8 deletions R/model.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
#' * infectivity: the infectivity from humans towards mosquitoes
#' * FOIM: the force of infection towards mosquitoes (per species)
#' * mu: the death rate of adult mosquitoes (per species)
#' * EIR: the Entomological Inoculation Rate (per timestep, per species, over
#' * EIR: the Entomological Inoculation Rate (per timestep, per species, over
#' the whole population)
#' * n_bitten: number of humans bitten by an infectious mosquito
#' * n_treated: number of humans treated for clinical or severe malaria this timestep
Expand All @@ -36,19 +36,16 @@
#' inclusive age range at this timestep. This
#' defaults to p_detect_730_3650. Other age ranges can be set with
#' prevalence_rendering_min_ages and prevalence_rendering_max_ages parameters.
#' * n_severe: number of humans with a severe infection between an inclusive
#' age range at this timestep. Age ranges can be set with
#' severe_prevalence_rendering_min_ages and severe_prevalence_rendering_max_ages parameters.
#' * n_inc: number of new infections for humans between an inclusive age range at this timestep.
#' incidence columns can be set with
#' incidence_rendering_min_ages and incidence_rendering_max_ages parameters.
#' * p_inc: sum of probabilities of infection for humans between an inclusive age range at this timestep.
#' incidence columns can be set with
#' incidence_rendering_min_ages and incidence_rendering_max_ages parameters.
#' * n_inc_clinical: number of new clinical infections for humans between an inclusive age range at this timestep.
#' * n_inc_clinical: number of new clinical infections for humans between an inclusive age range at this timestep.
#' clinical incidence columns can be set with
#' clinical_incidence_rendering_min_ages and clinical_incidence_rendering_max_ages parameters.
#' * p_inc_clinical: sub of probabilities of clinical infection for humans between an inclusive age range at this timestep.
#' * p_inc_clinical: sub of probabilities of clinical infection for humans between an inclusive age range at this timestep.
#' clinical incidence columns can be set with
#' clinical_incidence_rendering_min_ages and clinical_incidence_rendering_max_ages parameters.
#' * n_inc_severe: number of new severe infections for humans between an inclusive age range at this timestep.
Expand Down Expand Up @@ -193,7 +190,7 @@ run_resumable_simulation <- function(
#' @param correlations a list of correlation parameters for each population
#' (default: NULL)
#' @param mixing matrix of mixing coefficients for infectivity towards
#' mosquitoes. Rows = origin sites, columns = destinations. Each element must
#' mosquitoes. Rows = origin sites, columns = destinations. Each element must
#' be between 0 and 1 and all rows must sum to 1.
#' @return a list of dataframe of results
#' @export
Expand Down Expand Up @@ -280,7 +277,7 @@ run_metapop_simulation <- function(
events = unlist(events),
timesteps = timesteps
)

lapply(renderer, function(r) r$to_dataframe())
}

Expand Down
Loading

0 comments on commit da95b18

Please sign in to comment.