Make an xds Object to Study Human / Host Epidemiology

Source: R/xds_setup.R

A modified version of xds_setup that streamlines setup for models with a trival \(\cal MYZ\) component.

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

The \(\cal MYZ\) model is trivial. The funcion F_fqZ still passes the density of infectious adult mosquitoes, so \(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 \(\cal MYZ\) component.

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

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 model

Xopts

list to configure the X model

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 model

BFopts

list to configure the blood feeding model

model_name

a name for the model

Value

an xds object