Skip to contents

Make an xds Object to Study Human / Host Epidemiology

Source: R/xds_setup.R
xds_setup_human.Rd

A modified version of xds_setup that streamlines setup for models with a trival MYZ Component.

The xds object defines frame = class(frame) = 'human' to dispatch xde_derivatives.human or dts_update.human and associated functions.

The MYZ Component module is set to trivial. The funcion F_fqZ.trivial is called to compute passes the density of infectious adult mosquitoes, and \(f\) and \(q\) can still be configured. In this case, the daily EIR is computed using the blood feeding interface, including Exposure, in the same way as a model with a non-trivial MYZ Component module.

To study human cohort dynamics by passing a function that computes the daily EIR, consider using xds_setup_cohort.

Usage

xds_setup_human(
  Xname = "SIS",
  Xopts = list(),
  xds = "ode",
  nPatches = 1,
  residence = 1,
  HPop = 1000,
  Xday = 1,
  searchB = 1,
  TimeSpent = list(),
  MYZopts = list(),
  BFopts = list(),
  model_name = "unnamed"
)

Arguments

Xname

a character string defining a X Component module

Xopts

a named list to configure the X Component module

xds

is ode or dde or dts for ordinary OR delay differential OR difference equations

nPatches

the number of patches

residence

a vector that describes the patch where each human stratum lives

HPop

the number of humans in each patch

Xday

is the run-time time step for X Component (in days): integer or 1/integer

searchB

a vector of search weights for blood feeding

TimeSpent

either a TimeSpent matrix or a string to call a function that sets it up

MYZopts

list to configure the MYZ Component module

BFopts

list to configure the blood feeding model

model_name

a name for the model

Value

an xds object

See also

xds_setup and xds_setup_cohort