-
Notifications
You must be signed in to change notification settings - Fork 0
GeneratedSchema25Doc
This page is automatically generated from the following schema file: scenario_25.xsd.
I recommend against editing it because edits will likely be lost later.
Key:
abc required (one)
[ def ] optional (zero or one)
( ghi )* any number (zero or more)
( jkl )+ at least one
( mno ){2,inf} two or more occurrences
→ scenario
<scenario
schemaVersion=int
analysisNo=int
name=string
wuID=int
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="scenario_25.xsd"
>
IN THIS ORDER:
| <demography ... />
| <monitoring ... />
| <interventions ... />
| <healthSystem ... />
| <entoData ... />
| [ <drugDescription ... /> ]
| <model ... />
</scenario>Description of scenario
schemaVersion=intVersion of xml schema. If not equal to the current version an error is thrown. Use SchemaTranslator to update xml files.
analysisNo=intUnits: Number Min: 1 Max: 100000000
Unique identifier of scenario
name=stringUnits: string
Name of intervention
wuID=intUnits: Number Min: 1 Max: 100000000
Work unit ID. Only used to validate checkpointing, to prevent checkpoint cheats.
→ scenario → demography
<demography
name=string
popSize=int
maximumAgeYrs=double
[ growthRate=double ]
>
IN THIS ORDER:
| <ageGroup ... />
</demography>Description of demography
name=stringUnits: string
Name of demography data
popSize=intUnits: Count Min: 1 Max: 100000
Population size
maximumAgeYrs=doubleUnits: years Min: 0 Max: 100
Maximum age of simulated humans in years.
growthRate=doubleUnits: Number Min: 0 Max: 0
Growth rate of human population. (we should be able to implement this with non-zero values)
→ scenario → demography → ageGroup
<ageGroup
lowerbound=double
>
IN THIS ORDER:
| ( <group ... /> )+
</ageGroup>List of age groups included in demography
List of age groups included in demography or surveys
lowerbound=doubleUnits: Years Min: 0 Max: 100
Lower bound of age group
→ scenario → demography → ageGroup → group
<group
poppercent=double
upperbound=double
/>poppercent=doublePercentage of human population in age group
upperbound=doubleUnits: Years Min: 0 Max: 100
Upper bound of age group
→ scenario → monitoring
<monitoring
name=string
[ cohortOnly=boolean ]
[ firstBoutOnly=boolean ]
[ firstTreatmentOnly=boolean ]
[ firstInfectionOnly=boolean ]
>
IN THIS ORDER:
| [ <continuous ... /> ]
| <SurveyOptions ... />
| <surveys ... />
| <ageGroup ... />
</monitoring>Description of surveys
name=stringUnits: string
Name of monitoring data
cohortOnly=booleanIf true, for many output measures, the output comes only from individuals in the cohort; otherwise output is from the entire population.
Does not need to be specified if no cohort-selecting "interventions" are present.
firstBoutOnly=booleanIf true, remove individuals from the cohort at the start of the first episode (start of a clinical bout) since they were recruited into the cohort. This is intended for cohort studies that intend to measure time to first episode, using active case detection.
firstTreatmentOnly=booleanIf true, remove individuals from the cohort when they first seek treatment since they were recruited into the cohort. This is intended for cohort studies that intend to measure time to first episode, using passive case detection.
firstInfectionOnly=booleanIf true, remove individuals from the cohort at completion of the first survey in which they present with a patent infection since they were recruited into the cohort. This intended for cohort studies that intend to measure time to first infection, using active case detection.
→ scenario → monitoring → continuous
<continuous
period=int
[ duringInit=boolean ]
>
IN THIS ORDER:
| ( <option ... /> )*
</continuous>period=intUnits: Days Min: 1 Max: unbounded
Number of timesteps between reports.
duringInit=booleanUnits: Days Min: 1 Max: unbounded
Also output during initialization. By default this is disabled (only intervention-period data is output). This should not be used for predictions, but can be useful for model validation.
In this mode, 'simulation time' is output as the first column (in addition to 'timestep'), since 'timestep' is dis- continuous across the start of the intervention period.
→ scenario → monitoring → continuous → option
<option
name=string
[ value=boolean ] DEFAULT VALUE true
/>name=stringOptions define different model structures. Option name. Must be one of a strictly defined set. Options are not required to be listed if their default value is desired.
value=booleanDefault value: true
Option value (true/false). Each option has a default value used if the option is not listed (usually false but sometimes true).
→ scenario → monitoring → SurveyOptions
<SurveyOptions>
IN THIS ORDER:
| ( <option ... /> )*
</SurveyOptions>List of all active survey options. See include/Survey.h for a list of supported outputs. Should also be on the wiki.
→ scenario → monitoring → surveys
<surveys
detectionLimit=double
>
IN THIS ORDER:
| ( <surveyTime ... /> )+
</surveys>List of survey times
detectionLimit=doubleUnits: parasites/micolitre Min: 0 Max: 1000
Detection limit for parasitemia
→ scenario → monitoring → surveys → surveyTime
<surveyTime>
int
</surveyTime>Survey time; 0 means just before start of main sim and is a valid survey-point. Reported data is either from a point-time survey (immediate data) or is collected over the previous year (data from previous timesteps-per-year period). Simulation will end immediately after last survey is taken.
→ scenario → monitoring → ageGroup
<ageGroup
lowerbound=double
>
IN THIS ORDER:
| ( <group ... /> )+
</ageGroup>List of age groups included in demography or surveys
List of age groups included in surveys
lowerbound=doubleUnits: Years Min: 0 Max: 100
Lower bound of age group
→ scenario → monitoring → ageGroup → group
<group
upperbound=double
/>upperbound=doubleUnits: Years Min: 0 Max: 100
Upper bound of age group
<interventions
name=string
>
IN THIS ORDER:
| <descriptions ... />
| [ <continuous ... /> ]
| [ <timed ... /> ]
</interventions>List of interventions. Generally these are either point-time distributions of something to some subset of the population, or continuous-time distribution targetting individuals when they reach a certain age.
name=stringUnits: string
Name of age specific intervention
→ scenario → interventions → descriptions
<descriptions>
IN THIS ORDER:
| [ <MDADescription ... /> ]
| ( <vaccineDescription ... /> ){0,3}
| [ <iptiDescription ... /> ]
| ( <anopheles ... /> )*
</descriptions>Descriptions applying across all uses of an intervention.
→ scenario → interventions → descriptions → MDADescription
<MDADescription>
IN THIS ORDER:
| <decisions ... />
| <treatments ... />
</MDADescription>Description of treatment type used by mass treatment option of one-day case management model. Can be used to describe one-size-fits-all mass drug dosing, age-based mass drug dosing and screen-and-treat. Number of treatments given can be reported by the nMDAs option.
A set of decisions and a set of treatments.
→ scenario → interventions → descriptions → MDADescription → decisions
<decisions>
IN THIS ORDER:
| ( <decision ... /> )*
</decisions>Description of decisions for a case management tree. A generic view of this tree would be that each decision is deterministic, or based on probabilities which may depend on other decisions. Probabilistic decisions are described here.
In general, each decision has a name, a defined set of outcome values, and a set of dependent decisions mentioned by name. The following decisions, with their associated outcomes, are provided by the code (and may not be included here):
- case (uncomplicated only): Returns "UC1" if there is no recent history of a malarial case, or "UC2" if there is.
- result: Dependent on decision "test", this performs a parasite density test. Output is one of "none" (no test performed), "positive", "negative".
The following decisions must be described here:
- test (uncomplicated only): Outputs must be "none", "microscopy" or "RDT" to describe which test the "result" decision uses.
- treatment: Describes which treatment to use. Values aren't restricted but must match up with a treatment described in the corresponding "treatments" section.
- hospitalisation (complicated only): none, immediate or delayed.
→ scenario → interventions → descriptions → MDADescription → decisions → decision
<decision
name=string
depends=string
values=string
>
string
</decision>A decision describes how to choose between a set of values.
Lexically, it can contain symbols matching "[_.a-zA-Z0-9]+", round brackets: (), braces: {} and colons. Whitespace is ignored except to separate symbols.
Syntactically, it must match one TREE, where SYMBOL is a symbol described above. (Here, "x|y" means x or y, "x+" means x occurs once or more, brackets show grouping.) TREE := BRANCH_SET | OUTCOME BRANCH_SET := BRANCH+ BRANCH := DECISION '(' VALUE ')' ( ':' OUTCOME | '{' TREE '}' ) OUTCOME, DECISION, VALUE := SYMBOL
For each BRANCH_SET each BRANCH must have the same DECISION. This DECISION must be one of the dependencies mentioned in "depends". This may be:
- another decision, in which case the VALUE immediately following in brackets must correspond to one of its output values. The BRANCH_SET immediately containing this BRANCH must represent each output value of the same decision exactly once, and no parent BRANCH_SET may be for the same DECISION.
- "p": this indicates a probabilistic decision. In this case the value is a probability, the sum of all values for the BRANCH_SET must be 1 and the decision must be associated directly with OUTCOMEs (not sub-TREEs).
- "age": this indicates an age-test. The VALUE must have the form "a-b", indicating that this branch will be taken for individuals aged such that a <= age < b, where a,b are non-negative real numbers or the special value "inf", and a <= b. All VALUEs in the BRANCH_SET must cover all possible (non-negative real) ages, with no overlap (hence, smallest a must be 0 and greatest b must be inf).
Semantically, each OUTCOME must be one of the values associated with this decision.
name=stringThe name of this decision. The name must match the regular expression "[_a-zA-Z0-9]+"; that is it can only contain letters, digits and _ characters (no spaces, punctuation, etc.).
depends=stringA comma-separated list of decisions that must have already been evaluated before this decision can be evaluated. Can be empty. Each must be hard-coded or described here. Can include the special decisions "p" and "age", though "age" cannot be combined with any other dependency.
values=stringA comma-separated list of outcome values this decision may have. The name of each value must be of the same form as decision names (i.e. only contain letters, digits and _ characters).
→ scenario → interventions → descriptions → MDADescription → treatments
<treatments>
IN THIS ORDER:
| ( <treatment ... /> )*
</treatments>A list of drug treatment tables. Each should have a name corresponding to one of the "drug" decision's values.
→ scenario → interventions → descriptions → MDADescription → treatments → treatment
<treatment
name=string
>
IN THIS ORDER:
| <schedule ... />
| ( <modifier ... /> )*
</treatment>A description of a base treatment schedule along with modifiers to handle delays, quality variations, etc.
name=stringUnits: string
Name corresponding to one of the drug decision's output values.
→ scenario → interventions → descriptions → MDADescription → treatments → treatment → schedule
<schedule>
IN THIS ORDER:
| ( <medicate ... /> )*
</schedule>The base (unmodified) schedule of drugs administered for this treatment.
→ scenario → interventions → descriptions → MDADescription → treatments → treatment → schedule → medicate
<medicate
drug=string
mg=double
hour=double
[ duration=double ]
/>drug=stringUnits: string
Abbreviated name of drug compound
mg=doubleUnits: mg
Quantity of drug compound
hour=doubleUnits: hours Min: 0
Number of hours past start of timestep this drug dose is administered at (first dose should be at hour 0).
duration=doubleUnits: hours Min: 0
If this attribute is given, use IV administration instead of orally.
Specifies the number of hours over which the dose is administered.
→ scenario → interventions → descriptions → MDADescription → treatments → treatment → modifier
<modifier
decision=string
>
EXACTLY ONE OF:
| ( <multiplyQty ... /> )*
| ( <delay ... /> )*
| ( <selectTimeRange ... /> )*
</modifier>A modifier for this treatment, according to the outputs of a decision.
The "decision" attribute must be the name of a known decision. Then, there must be a set of multipyQty, delay or selectTimeRange sub-elements, each of which corresponds to one value output of the decision.
decision=stringUnits: string
Specifies the decision that this modifier acts on.
→ scenario → interventions → descriptions → MDADescription → treatments → treatment → modifier → multiplyQty
<multiplyQty
value=string
effect=string
[ affectsCost=boolean ]
/>Multiplies the quantity of active ingredients of drugs administered.
The "drugs" attribute is a comma-separated list of all active ingredients administered in the base schedule (each must be listed once) and the content of this element is a comma- separated list of multipliers for each active ingredient, listed in the same order as in the "drugs" attribute. E.g. with drugs="A,B" and content "0.5,1" the quantity of drug A is halved while that of B is unchanged.
value=stringUnits: string
Specifies a value of the decision to act on.
effect=stringUnits: string
Comma-separated list of the effect the modifier has on each drug, in the form DRUG1(EFFECT1),DRUG2(EFFECT2), etc.
affectsCost=booleanUnits: none
Does this affect the cost? If false, the effective drug usage (w.r.t. cost) is unaffected by this modifier; if true it is. Defaults to true (if omitted).
Is meaningless for delays.
→ scenario → interventions → descriptions → MDADescription → treatments → treatment → modifier → delay
<delay
value=string
effect=string
[ affectsCost=boolean ]
/>Delays administration of drugs listed in the base schedule by so many hours.
The "drugs" attribute is a comma-separated list of all active ingredients administered in the base schedule (each must be listed once) and the content of this element is a comma- separated list of delays (in hours) for each active ingredient, listed in the same order as in the "drugs" attribute. E.g. with drugs="A,B" and content "0,6", drug A is administered as in the base schedule while drug B is administered 6 hours later than specified.
value=stringUnits: string
Specifies a value of the decision to act on.
effect=stringUnits: string
Comma-separated list of the effect the modifier has on each drug, in the form DRUG1(EFFECT1),DRUG2(EFFECT2), etc.
affectsCost=booleanUnits: none
Does this affect the cost? If false, the effective drug usage (w.r.t. cost) is unaffected by this modifier; if true it is. Defaults to true (if omitted).
Is meaningless for delays.
→ scenario → interventions → descriptions → MDADescription → treatments → treatment → modifier → selectTimeRange
<selectTimeRange
value=string
effect=string
[ affectsCost=boolean ]
/>Selects which drug doses to administer according to time of administration (before times are modified by delays). Half-open interval: [x,y)
The "drugs" attribute is a comma-separated list of all active ingredients administered in the base schedule (each must be listed once) and the content of this element is a comma- separated list of time-ranges (in hours) for each active ingredient, listed in the same order as in the "drugs" attribute. The time-ranges should be of the form x-y and are interpreted as the half-open interval [x,y); that is a drug listed with time t will only be administered if x <= t < y.
value=stringUnits: string
Specifies a value of the decision to act on.
effect=stringUnits: string
Comma-separated list of the effect the modifier has on each drug, in the form DRUG1(EFFECT1),DRUG2(EFFECT2), etc.
affectsCost=booleanUnits: none
Does this affect the cost? If false, the effective drug usage (w.r.t. cost) is unaffected by this modifier; if true it is. Defaults to true (if omitted).
Is meaningless for delays.
→ scenario → interventions → descriptions → vaccineDescription
<vaccineDescription
vaccineType=("PEV" or "BSV" or "TBV")
>
IN THIS ORDER:
| <decay ... />
| <efficacyB ... />
| ( <initialEfficacy ... /> )+
</vaccineDescription>vaccineType=("PEV" or "BSV" or "TBV")Units: Code
Type of vaccine
→ scenario → interventions → descriptions → vaccineDescription → decay
<decay
function=("constant" or "linear" or "exponential" or "weibull" or "hill" or "chitnis")
L=double
[ k=double ] DEFAULT VALUE 1.0
/>Specification of decay of efficacy
Specification of decay or survival of a parameter.
function=("constant" or "linear" or "exponential" or "weibull" or "hill" or "chitnis")Units: None Min: 0 Max: 1
Determines which decay function to use. Available decay functions, for age t in years:
constant: initial
linear: initial * (1 - t/L)
exponential: initial * exp( - t/L * log(2) )
weibull: initial * exp( -(t/L)^k * log(2) )
hill: initial / (1 + (t/L)^k)
chitnis: initial * exp( k - k / (1 - (t/L)^2) ) for t less than L, 0 for t greater than or equal to L.
L=doubleUnits: Years Min: 0
Scale parameter of distribution. With Chintnis' function, this is the age at which the parameter has decayed to 0; with the other three functions, this is the age at which the parameter has decayed to half its original value. Not used for constant decay (though must be specified anyway).
k=doubleUnits: none Min: 0 Default value: 1.0
Shape parameter of distribution. If not specified, default value of 1 is used. Meaning depends on function; not used in some cases.
→ scenario → interventions → descriptions → vaccineDescription → efficacyB
<efficacyB
value=double
/>Measure of variation in vaccine efficacy
value=doubleA double-precision floating-point value.
→ scenario → interventions → descriptions → vaccineDescription → initialEfficacy
<initialEfficacy
value=double
/>value=doubleA double-precision floating-point value.
→ scenario → interventions → descriptions → iptiDescription
<iptiDescription
iptiEffect=int
>
IN THIS ORDER:
| ( <infGenotype ... /> )+
</iptiDescription>iptiEffect=int→ scenario → interventions → descriptions → iptiDescription → infGenotype
<infGenotype
name=string
freq=double
ACR=double
proph=int
tolPeriod=int
atten=double
/>name=stringUnits: string
Name of age specific intervention
freq=doubleFrequency of parasite genotype
ACR=doubleAdequate clinical response (proportion)
proph=intProphylactic period
tolPeriod=intTolerance period
atten=doubleTolerance period
→ scenario → interventions → descriptions → anopheles
<anopheles
mosquito=string
>
IN THIS ORDER:
| [ <ITNDescription ... /> ]
| [ <IRSDescription ... /> ]
| [ <VADescription ... /> ]
</anopheles>mosquito=stringDescription of the entomological effects of interventions
→ scenario → interventions → descriptions → anopheles → ITNDescription
<ITNDescription>
IN THIS ORDER:
| <deterrency ... />
</ITNDescription>→ scenario → interventions → descriptions → anopheles → ITNDescription → deterrency
<deterrency
initial=double
/>One minus this multiplies the host's availability.
Specification of decay or survival of a parameter along with initial value.
Specification of decay or survival of a parameter.
initial=doubleUnits: None Min: 0 Max: 1
The value before any decay.
→ scenario → interventions → descriptions → anopheles → ITNDescription → preprandialKillingEffect
<preprandialKillingEffect
initial=double
/>One minus this multiplies the survival rate of mosquitoes attempting to bite a host.
Specification of decay or survival of a parameter along with initial value.
Specification of decay or survival of a parameter.
initial=doubleUnits: None Min: 0 Max: 1
The value before any decay.
→ scenario → interventions → descriptions → anopheles → ITNDescription → postprandialKillingEffect
<postprandialKillingEffect
initial=double
/>One minus this multiplies the survival rate of mosquitoes attempting to escape after biting a host.
Specification of decay or survival of a parameter along with initial value.
Specification of decay or survival of a parameter.
initial=doubleUnits: None Min: 0 Max: 1
The value before any decay.
→ scenario → interventions → descriptions → anopheles → IRSDescription
<IRSDescription>
IN THIS ORDER:
| <deterrency ... />
</IRSDescription>→ scenario → interventions → descriptions → anopheles → IRSDescription → killingEffect
<killingEffect
initial=double
/>One minus this multiplies the survival rate of resting mosquitoes.
Specification of decay or survival of a parameter along with initial value.
Specification of decay or survival of a parameter.
initial=doubleUnits: None Min: 0 Max: 1
The value before any decay.
→ scenario → interventions → descriptions → anopheles → VADescription
<VADescription
name=string
>
IN THIS ORDER:
| <deterrency ... />
</VADescription>name=stringUnits: string
Name of intervention
→ scenario → interventions → continuous
<continuous>
IN THIS ORDER:
| ( <vaccine ... /> )*
| ( <ITN ... /> )*
| ( <ipti ... /> )*
| ( <cohort ... /> )*
</continuous>→ scenario → interventions → continuous → vaccine
<vaccine
targetAgeYrs=double
coverage=double
[ cohort=boolean ] DEFAULT VALUE false
[ begin=int ] DEFAULT VALUE 0
[ end=int ] DEFAULT VALUE 2147483647
/>List of age groups for vaccination
targetAgeYrs=doubleUnits: Years Min: 0 Max: 100
Target age of intervention
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
cohort=booleanUnits: Proportion Min: 0 Max: 1 Default value: false
Restrict distribution to chosen cohort (default: false).
begin=intUnits: Timesteps Min: 0 Max: 2147483647 Default value: 0
First timestep (from 0 at the beginning of the intervention period) this item is active. Defaults to 0.
end=intUnits: Timesteps Min: 0 Max: 2147483647 Default value: 2147483647
End of the period during which the intervention is active (to be exact, the first timestep of the intervention period at which the item becomes inactive). Defaults to 2147483647.
→ scenario → interventions → continuous → ITN
<ITN
targetAgeYrs=double
coverage=double
[ cohort=boolean ] DEFAULT VALUE false
[ begin=int ] DEFAULT VALUE 0
[ end=int ] DEFAULT VALUE 2147483647
/>Description of ITN deployment in the community
targetAgeYrs=doubleUnits: Years Min: 0 Max: 100
Target age of intervention
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
cohort=booleanUnits: Proportion Min: 0 Max: 1 Default value: false
Restrict distribution to chosen cohort (default: false).
begin=intUnits: Timesteps Min: 0 Max: 2147483647 Default value: 0
First timestep (from 0 at the beginning of the intervention period) this item is active. Defaults to 0.
end=intUnits: Timesteps Min: 0 Max: 2147483647 Default value: 2147483647
End of the period during which the intervention is active (to be exact, the first timestep of the intervention period at which the item becomes inactive). Defaults to 2147483647.
→ scenario → interventions → continuous → ipti
<ipti
targetAgeYrs=double
coverage=double
[ cohort=boolean ] DEFAULT VALUE false
[ begin=int ] DEFAULT VALUE 0
[ end=int ] DEFAULT VALUE 2147483647
/>List of age groups for IPTi distribution
targetAgeYrs=doubleUnits: Years Min: 0 Max: 100
Target age of intervention
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
cohort=booleanUnits: Proportion Min: 0 Max: 1 Default value: false
Restrict distribution to chosen cohort (default: false).
begin=intUnits: Timesteps Min: 0 Max: 2147483647 Default value: 0
First timestep (from 0 at the beginning of the intervention period) this item is active. Defaults to 0.
end=intUnits: Timesteps Min: 0 Max: 2147483647 Default value: 2147483647
End of the period during which the intervention is active (to be exact, the first timestep of the intervention period at which the item becomes inactive). Defaults to 2147483647.
→ scenario → interventions → continuous → cohort
<cohort
targetAgeYrs=double
coverage=double
[ cohort=boolean ] DEFAULT VALUE false
[ begin=int ] DEFAULT VALUE 0
[ end=int ] DEFAULT VALUE 2147483647
/>Description of continuous selection of individuals for a cohort study.
targetAgeYrs=doubleUnits: Years Min: 0 Max: 100
Target age of intervention
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
cohort=booleanUnits: Proportion Min: 0 Max: 1 Default value: false
Restrict distribution to chosen cohort (default: false).
begin=intUnits: Timesteps Min: 0 Max: 2147483647 Default value: 0
First timestep (from 0 at the beginning of the intervention period) this item is active. Defaults to 0.
end=intUnits: Timesteps Min: 0 Max: 2147483647 Default value: 2147483647
End of the period during which the intervention is active (to be exact, the first timestep of the intervention period at which the item becomes inactive). Defaults to 2147483647.
→ scenario → interventions → timed
<timed>
IN THIS ORDER:
| ( <intervention ... /> )+
</timed>List of timed interventions
List of timed interventions
→ scenario → interventions → timed → intervention
<intervention
time=int
>
IN THIS ORDER:
| [ <changeHS ... /> ]
| [ <changeEIR ... /> ]
| [ <importedInfectionsPerThousandHosts ... /> ]
| [ <MDA ... /> ]
| [ <vaccinate ... /> ]
| [ <ITN ... /> ]
| [ <IRS ... /> ]
| [ <VectorAvailability ... /> ]
| [ <ipti ... /> ]
| [ <immuneSuppression ... /> ]
| [ <insertR_0Case ... /> ]
| [ <uninfectVectors ... /> ]
| [ <larviciding ... /> ]
| [ <cohort ... /> ]
</intervention>- changeHS
- changeEIR
- importedInfectionsPerThousandHosts
- MDA
- vaccinate
- ITN
- IRS
- VectorAvailability
- ipti
- immuneSuppression
- insertR_0Case
- uninfectVectors
- larviciding
- cohort
time=intUnits: Number Min: 1 Max: 10000
Time step of intervention
→ scenario → interventions → timed → intervention → changeHS
<changeHS>
IN THIS ORDER:
| EXACTLY ONE OF:
| | <EventScheduler ... />
| | <ImmediateOutcomes ... />
| <CFR ... />
| <pSequelaeInpatient ... />
</changeHS>Description of case management system, used to specify the initial model or a replacement (an intervention). Encompasses case management data and some other data required to derive case outcomes.
Contains a sub-element describing the particular health-system in use. Health system data is here defined as data used to decide on a treatment strategy, given a case requiring treatment.
→ scenario → healthSystem → EventScheduler
<EventScheduler>
IN THIS ORDER:
| <uncomplicated ... />
| <complicated ... />
| <ClinicalOutcomes ... />
| [ <NonMalariaFevers ... /> ]
</EventScheduler>→ scenario → healthSystem → EventScheduler → uncomplicated
<uncomplicated>
IN THIS ORDER:
| <decisions ... />
| <treatments ... />
</uncomplicated>A set of decisions and a set of treatments.
→ scenario → healthSystem → EventScheduler → complicated
<complicated>
IN THIS ORDER:
| <decisions ... />
| <treatments ... />
</complicated>A set of decisions and a set of treatments.
→ scenario → healthSystem → EventScheduler → ClinicalOutcomes
<ClinicalOutcomes>
IN THIS ORDER:
| <maxUCSeekingMemory ... />
| <uncomplicatedCaseDuration ... />
| <complicatedCaseDuration ... />
| <complicatedRiskDuration ... />
| <pImmediateUC ... />
</ClinicalOutcomes>- maxUCSeekingMemory
- uncomplicatedCaseDuration
- complicatedCaseDuration
- complicatedRiskDuration
- pImmediateUC
Description of base parameters of the clinical model.
→ scenario → healthSystem → EventScheduler → ClinicalOutcomes → maxUCSeekingMemory
<maxUCSeekingMemory>
int
</maxUCSeekingMemory>Maximum number of timesteps (including first of case) an individual will remember they are sick before resetting.
→ scenario → healthSystem → EventScheduler → ClinicalOutcomes → uncomplicatedCaseDuration
<uncomplicatedCaseDuration>
int
</uncomplicatedCaseDuration>Fixed length of an uncomplicated case of malarial/non-malarial sickness (from treatment seeking until return to life-as-usual). Usually 3.
→ scenario → healthSystem → EventScheduler → ClinicalOutcomes → complicatedCaseDuration
<complicatedCaseDuration>
int
</complicatedCaseDuration>Fixed length of a complicated/severe case of malaria (from treatment seeking until return to life-as-usual).
→ scenario → healthSystem → EventScheduler → ClinicalOutcomes → complicatedRiskDuration
<complicatedRiskDuration>
int
</complicatedRiskDuration>Number of days for which humans are at risk of death during a severe or complicated case of malaria. Cannot be greater than the duration of a complicated case or less than 1 day.
→ scenario → healthSystem → EventScheduler → ClinicalOutcomes → pImmediateUC
<pImmediateUC>
double
</pImmediateUC>Probability that UC treatment seeking will be done immediately when sick, on second day given that it wasn't done on first, etc.
→ scenario → healthSystem → EventScheduler → NonMalariaFevers
<NonMalariaFevers>
IN THIS ORDER:
| <prTreatment ... />
| <effectNegativeTest ... />
| <effectPositiveTest ... />
| <effectNeed ... />
| <effectInformal ... />
| <CFR ... />
| <TreatmentEfficacy ... />
</NonMalariaFevers>Description of non-malaria fever health-system modelling (treatment, outcomes and costing). Incidence is described by the model->clinical->NonMalariaFevers element. Non-malaria fevers are only modelled if the NON_MALARIA_FEVERS option is used.
As further explanation of the parameters below, we first take: β₀ = logit(P₀) - β₃·P(need), and then calculate the probability of antibiotic administration, P(AB), dependent on treatment seeking location. No seeking: P(AB) = 0 Informal sector: logit(P(AB)) = β₀ + β₄ Health facility: logit(P(AB)) = β₀ + β₁·I(neg) + β₂·I(pos) + β₃·I(need) (where I(X) is 1 when event X is true and 0 otherwise, logit(p)=log(p/(1-p)), event "need" is the event that death may occur without treatment, events "neg" and "pos" are the events that a malaria parasite diagnositic was used and indicated no parasites and parasites respectively).
→ scenario → healthSystem → EventScheduler → NonMalariaFevers → prTreatment
<prTreatment>
double
</prTreatment>Probability of a non-malaria fever being treated with an antibiotic given that no malaria diagnostic was used but independent of need. Symbol: P₀.
→ scenario → healthSystem → EventScheduler → NonMalariaFevers → effectNegativeTest
<effectNegativeTest>
double
</effectNegativeTest>The effect of a negative malaria diagnostic on the odds ratio of receiving antibiotics. Symbol: exp(β₁).
→ scenario → healthSystem → EventScheduler → NonMalariaFevers → effectPositiveTest
<effectPositiveTest>
double
</effectPositiveTest>The effect of a positive malaria diagnostic on the odds ratio of receiving antibiotics. Symbol: exp(β₂).
→ scenario → healthSystem → EventScheduler → NonMalariaFevers → effectNeed
<effectNeed>
double
</effectNeed>The effect of needing antibiotic treatment on the odds ratio of receiving antibiotics. Symbol: exp(β₃).
→ scenario → healthSystem → EventScheduler → NonMalariaFevers → effectInformal
<effectInformal>
double
</effectInformal>The effect of seeking treatment from an informal provider (i.e. a provider untrained in NMF diagnosis) on the odds ratio of receiving antibiotics. Symbol: exp(β₄)
→ scenario → healthSystem → EventScheduler → NonMalariaFevers → CFR
<CFR
[ interpolation=("none" or "linear") ] DEFAULT VALUE linear
>
IN THIS ORDER:
| ( <group ... /> )+
</CFR>Base case fatality rate for non-malaria fevers (probability of death from a fever requiring antibiotic treatment given that no antibiotic treatment is received, per age-group).
interpolation=("none" or "linear")Units: none Default value: linear
Interpolation algorithm. Normally it is desirable for age-based values to be continuous w.r.t. age. By default linear interpolation is used.
With all algorithms except "none", the age groups are converted to a set of points centred within each age range. Extra points are added at each end (zero and infinity) to keep value constant at both ends of the function. A zero-length age group may be used as a kind of barrier to adjust the distribution; e.g. with age group boundaries at 15, 20 and 25 years, a (linear) spline would be drawn between ages 17.5 and 22.5, whereas with boundaries at 15, 20 and 20 years, a spline would be drawn between ages 17.5 and 20 years (may be desired if individuals are assumed to reach adult size at 20).
Algorithms:
- none: input values are used directly
- linear: straight lines (on an age vs. value graph) are used to interpolate data points.
→ scenario → healthSystem → CFR → group
<group
lowerbound=double
/>A series of values according to age groups, each specified with a lower-bound and a value. The first lower-bound specified must be zero; a final upper-bound of infinity is added to complete the last age group. At least one age group is required. Normally these are interpolated by a continuous function (see interpolation attribute).
lowerbound=doubleUnits: Years Min: 0 Max: 100
Lower bound of age group
→ scenario → healthSystem → EventScheduler → NonMalariaFevers → TreatmentEfficacy
<TreatmentEfficacy>
double
</TreatmentEfficacy>Probability that treatment would prevent a death (i.e. CFR is multiplied by one minus this when treatment occurs).
→ scenario → healthSystem → ImmediateOutcomes
<ImmediateOutcomes
name=string
>
IN THIS ORDER:
| <drugRegimen ... />
| <initialACR ... />
| <compliance ... />
| <nonCompliersEffective ... />
| <pSeekOfficialCareUncomplicated1 ... />
| <pSelfTreatUncomplicated ... />
| <pSeekOfficialCareUncomplicated2 ... />
| <pSeekOfficialCareSevere ... />
</ImmediateOutcomes>- drugRegimen
- initialACR
- compliance
- nonCompliersEffective
- pSeekOfficialCareUncomplicated1
- pSelfTreatUncomplicated
- pSeekOfficialCareUncomplicated2
- pSeekOfficialCareSevere
Description of "immediate outcomes" health system: Tediosi et al case management model (Case management as described in AJTMH 75 (suppl 2) pp90-103).
name=stringUnits: string
Name of health system
→ scenario → healthSystem → ImmediateOutcomes → drugRegimen
<drugRegimen
firstLine=string
secondLine=string
inpatient=string
/>Description of drug regimen
firstLine=stringUnits: Drug code
Code for first line drug
secondLine=stringUnits: Drug code
Code for second line drug
inpatient=stringUnits: Drug code
Code for drug used for treating inpatients
→ scenario → healthSystem → ImmediateOutcomes → initialACR
<initialACR>
IN THIS ORDER:
| [ <CQ ... /> ]
| [ <SP ... /> ]
| [ <AQ ... /> ]
| [ <SPAQ ... /> ]
| [ <ACT ... /> ]
| [ <QN ... /> ]
| <selfTreatment ... />
</initialACR>Initial cure rate
→ scenario → healthSystem → ImmediateOutcomes → initialACR → CQ
<CQ
value=double
/>Chloroquine
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → ImmediateOutcomes → initialACR → SP
<SP
value=double
/>Sulphadoxine-pyrimethamine
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → ImmediateOutcomes → initialACR → AQ
<AQ
value=double
/>Amodiaquine
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → ImmediateOutcomes → initialACR → SPAQ
<SPAQ
value=double
/>Sulphadoxine-pyrimethamine/Amodiaquine
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → ImmediateOutcomes → initialACR → ACT
<ACT
value=double
/>Artemisinine combination therapy
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → ImmediateOutcomes → initialACR → QN
<QN
value=double
/>Quinine
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → ImmediateOutcomes → initialACR → selfTreatment
<selfTreatment
value=double
/>Probability of self-treatment
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → ImmediateOutcomes → compliance
<compliance>
IN THIS ORDER:
| [ <CQ ... /> ]
| [ <SP ... /> ]
| [ <AQ ... /> ]
| [ <SPAQ ... /> ]
| [ <ACT ... /> ]
| [ <QN ... /> ]
| <selfTreatment ... />
</compliance>Adherence to treatment
→ scenario → healthSystem → ImmediateOutcomes → nonCompliersEffective
<nonCompliersEffective>
IN THIS ORDER:
| [ <CQ ... /> ]
| [ <SP ... /> ]
| [ <AQ ... /> ]
| [ <SPAQ ... /> ]
| [ <ACT ... /> ]
| [ <QN ... /> ]
| <selfTreatment ... />
</nonCompliersEffective>Effectiveness of treatment of non compliers
→ scenario → healthSystem → ImmediateOutcomes → pSeekOfficialCareUncomplicated1
<pSeekOfficialCareUncomplicated1
value=double
/>Probability that a patient with newly incident uncomplicated disease seeks official care
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → ImmediateOutcomes → pSelfTreatUncomplicated
<pSelfTreatUncomplicated
value=double
/>Probability that a patient with uncomplicated disease self-treats
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → ImmediateOutcomes → pSeekOfficialCareUncomplicated2
<pSeekOfficialCareUncomplicated2
value=double
/>Probability that a patient with recurrence of uncomplicated disease seeks official care
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → ImmediateOutcomes → pSeekOfficialCareSevere
<pSeekOfficialCareSevere
value=double
/>Probability that a patient with severe disease obtains appropriate care
value=doubleA double-precision floating-point value.
→ scenario → healthSystem → CFR
<CFR
[ interpolation=("none" or "linear") ] DEFAULT VALUE linear
>
IN THIS ORDER:
| ( <group ... /> )+
</CFR>Case fatality rate (probability of an inpatient fatality from a bout of severe malaria, per age-group).
interpolation=("none" or "linear")Units: none Default value: linear
Interpolation algorithm. Normally it is desirable for age-based values to be continuous w.r.t. age. By default linear interpolation is used.
With all algorithms except "none", the age groups are converted to a set of points centred within each age range. Extra points are added at each end (zero and infinity) to keep value constant at both ends of the function. A zero-length age group may be used as a kind of barrier to adjust the distribution; e.g. with age group boundaries at 15, 20 and 25 years, a (linear) spline would be drawn between ages 17.5 and 22.5, whereas with boundaries at 15, 20 and 20 years, a spline would be drawn between ages 17.5 and 20 years (may be desired if individuals are assumed to reach adult size at 20).
Algorithms:
- none: input values are used directly
- linear: straight lines (on an age vs. value graph) are used to interpolate data points.
→ scenario → healthSystem → pSequelaeInpatient
<pSequelaeInpatient
[ interpolation=("none" or "linear") ] DEFAULT VALUE linear
>
IN THIS ORDER:
| ( <group ... /> )+
</pSequelaeInpatient>List of age specific probabilities of sequelae in inpatients, during a severe bout.
interpolation=("none" or "linear")Units: none Default value: linear
Interpolation algorithm. Normally it is desirable for age-based values to be continuous w.r.t. age. By default linear interpolation is used.
With all algorithms except "none", the age groups are converted to a set of points centred within each age range. Extra points are added at each end (zero and infinity) to keep value constant at both ends of the function. A zero-length age group may be used as a kind of barrier to adjust the distribution; e.g. with age group boundaries at 15, 20 and 25 years, a (linear) spline would be drawn between ages 17.5 and 22.5, whereas with boundaries at 15, 20 and 20 years, a spline would be drawn between ages 17.5 and 20 years (may be desired if individuals are assumed to reach adult size at 20).
Algorithms:
- none: input values are used directly
- linear: straight lines (on an age vs. value graph) are used to interpolate data points.
→ scenario → interventions → timed → intervention → changeEIR
<changeEIR
eipDuration=int
>
IN THIS ORDER:
| ( <EIRDaily ... /> )+
</changeEIR>New description of transmission setting for models without vector control interventions (included for backward compatibility)
eipDuration=intThe duration of sporogony in days
→ scenario → entoData → nonVector → EIRDaily
<EIRDaily
[ origin=string ]
>
double
</EIRDaily>In the non-vector model, EIR is input as a sequence of daily values. There must be at least a years' worth of entries (365), and if there are more, values are wrapped and averaged (i.e. value for first day of year is taken as the mean of values for days 0, 365+0, 2*365+0, etc.).
origin=string→ scenario → interventions → timed → intervention → importedInfectionsPerThousandHosts
<importedInfectionsPerThousandHosts>
double
</importedInfectionsPerThousandHosts>Import infections (as if a mosquito bites a human). Imported via a Bernoulli trial per host.
→ scenario → interventions → timed → intervention → MDA
<MDA
[ maxAge=double ] DEFAULT VALUE 100
[ minAge=double ] DEFAULT VALUE 0
coverage=double
[ cohort=boolean ] DEFAULT VALUE false
/>Description of mass drug deployment in the community.
maxAge=doubleUnits: Years Min: 0 Max: 100 Default value: 100
Maximum age of eligible individuals (defaults to 100)
minAge=doubleUnits: Years Min: 0 Max: 100 Default value: 0
Minimum age of eligible individuals (defaults to 0)
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
cohort=booleanUnits: Proportion Min: 0 Max: 1 Default value: false
Restrict distribution to chosen cohort.
→ scenario → interventions → timed → intervention → vaccinate
<vaccinate
[ cumulativeWithMaxAge=double ]
/>Description of vaccine deployment in the community
cumulativeWithMaxAge=doubleUnits: Years Min: 0
If present, activate cumulate deployment mode where intervention is only deployed to individuals not already considered protected in sufficient quantity to bring the total proportion of people covered up to level described by "coverage".
Individuals are considered already protected by this intervention when the age of the last net/dose/etc. received is less than "maximum age" (this attribute) years old (i.e. when timeLastDeployment+maximumAge>currentTimeStep).
→ scenario → interventions → timed → intervention → ITN
<ITN
[ cumulativeWithMaxAge=double ]
/>Description of ITN deployment in the community
cumulativeWithMaxAge=doubleUnits: Years Min: 0
If present, activate cumulate deployment mode where intervention is only deployed to individuals not already considered protected in sufficient quantity to bring the total proportion of people covered up to level described by "coverage".
Individuals are considered already protected by this intervention when the age of the last net/dose/etc. received is less than "maximum age" (this attribute) years old (i.e. when timeLastDeployment+maximumAge>currentTimeStep).
→ scenario → interventions → timed → intervention → IRS
<IRS
[ cumulativeWithMaxAge=double ]
/>Description of IRS deployment in the community
cumulativeWithMaxAge=doubleUnits: Years Min: 0
If present, activate cumulate deployment mode where intervention is only deployed to individuals not already considered protected in sufficient quantity to bring the total proportion of people covered up to level described by "coverage".
Individuals are considered already protected by this intervention when the age of the last net/dose/etc. received is less than "maximum age" (this attribute) years old (i.e. when timeLastDeployment+maximumAge>currentTimeStep).
→ scenario → interventions → timed → intervention → VectorAvailability
<VectorAvailability
[ cumulativeWithMaxAge=double ]
/>Description of a mosquito deterrent deployment in the community
cumulativeWithMaxAge=doubleUnits: Years Min: 0
If present, activate cumulate deployment mode where intervention is only deployed to individuals not already considered protected in sufficient quantity to bring the total proportion of people covered up to level described by "coverage".
Individuals are considered already protected by this intervention when the age of the last net/dose/etc. received is less than "maximum age" (this attribute) years old (i.e. when timeLastDeployment+maximumAge>currentTimeStep).
→ scenario → interventions → timed → intervention → ipti
<ipti
[ cumulativeWithMaxAge=double ]
/>List of age groups for IPTi distribution
cumulativeWithMaxAge=doubleUnits: Years Min: 0
If present, activate cumulate deployment mode where intervention is only deployed to individuals not already considered protected in sufficient quantity to bring the total proportion of people covered up to level described by "coverage".
Individuals are considered already protected by this intervention when the age of the last net/dose/etc. received is less than "maximum age" (this attribute) years old (i.e. when timeLastDeployment+maximumAge>currentTimeStep).
→ scenario → interventions → timed → intervention → immuneSuppression
<immuneSuppression
[ maxAge=double ] DEFAULT VALUE 100
[ minAge=double ] DEFAULT VALUE 0
coverage=double
[ cohort=boolean ] DEFAULT VALUE false
/>Removes all exposure-related immunity gained over time by hosts without removing infections.
Hypothetical, but potentially useful to simulate scenarios with unprotected humans.
maxAge=doubleUnits: Years Min: 0 Max: 100 Default value: 100
Maximum age of eligible individuals (defaults to 100)
minAge=doubleUnits: Years Min: 0 Max: 100 Default value: 0
Minimum age of eligible individuals (defaults to 0)
coverage=doubleUnits: Proportion Min: 0 Max: 1
Coverage of intervention
cohort=booleanUnits: Proportion Min: 0 Max: 1 Default value: false
Restrict distribution to chosen cohort.
→ scenario → interventions → timed → intervention → insertR_0Case
<insertR_0Case/>Used to simulate R_0. First, infections should be eliminated, immunity removed, and the population given an effective transmission- blocking vaccine (not done by this intervention). Then this intervention may be used to: pick one human, infect him, administer a fully effective Preerythrocytic vaccine and remove transmission-blocking vaccine effect on this human. Thus only this one human will be a source of infections in an unprotected population, and will not reinfected himself.
→ scenario → interventions → timed → intervention → uninfectVectors
<uninfectVectors/>Removes all infections from mosquitoes -- resulting in zero EIR to humans, until such time that mosquitoes are re-infected and become infectious. Only effectious in dynamic EIR mode (when changeEIR was not used).
Hypothetical, but potentially useful to simulate a setting starting from no infections, but with enough mosquitoes to reach a set equilibrium of exposure.
→ scenario → interventions → timed → intervention → larviciding
<larviciding>
IN THIS ORDER:
| ( <anopheles ... /> )+
</larviciding>Simple larviciding intervention description.
→ scenario → interventions → timed → intervention → larviciding → anopheles
<anopheles
mosquito=string
effectiveness=double
duration=int
/>mosquito=stringMosquito to be larvicided
effectiveness=doubleUnits: none Min: 0 Max: 1
Proportional reduction in emergence rate
duration=intUnits: days Min: 0 Max: inf
Number of days for which the intervention is active.
→ scenario → interventions → timed → intervention → cohort
<cohort
[ cumulativeWithMaxAge=double ]
/>Description of mass cohort selection.
cumulativeWithMaxAge=doubleUnits: Years Min: 0
If present, activate cumulate deployment mode where intervention is only deployed to individuals not already considered protected in sufficient quantity to bring the total proportion of people covered up to level described by "coverage".
Individuals are considered already protected by this intervention when the age of the last net/dose/etc. received is less than "maximum age" (this attribute) years old (i.e. when timeLastDeployment+maximumAge>currentTimeStep).
→ scenario → healthSystem
<healthSystem>
IN THIS ORDER:
| EXACTLY ONE OF:
| | <EventScheduler ... />
| | <ImmediateOutcomes ... />
| <CFR ... />
| <pSequelaeInpatient ... />
</healthSystem>Description of case management system, used to specify the initial model or a replacement (an intervention). Encompasses case management data and some other data required to derive case outcomes.
Contains a sub-element describing the particular health-system in use. Health system data is here defined as data used to decide on a treatment strategy, given a case requiring treatment.
<entoData
name=string
mode=("2" or "4")
[ annualEIR=double ]
>
IN THIS ORDER:
| EXACTLY ONE OF:
| | <nonVector ... />
| | <vector ... />
</entoData>Description of entomological data
name=stringUnits: string
Name of entomology data
mode=("2" or "4")Units: Code
Transmission simulation mode -- enter dynamic mode (4) or forced mode (2) at start of intervention period. Mode 3 (transient EIR from data provided as intervention) is set when intervention data is applied, and is no longer a valid value to specify here.
annualEIR=doubleUnits: Infectious bites per adult per year
If set, overrides the annual EIR by scaling it to this level. If ommitted, EIR levels are as specified elsewhere.
→ scenario → entoData → nonVector
<nonVector
eipDuration=int
>
IN THIS ORDER:
| ( <EIRDaily ... /> )+
</nonVector>Description of transmission setting for models without vector control interventions (included for backward compatibility)
eipDuration=intThe duration of sporogony in days
→ scenario → entoData → vector
<vector>
IN THIS ORDER:
| ( <anopheles ... /> )+
| ( <nonHumanHosts ... /> )*
</vector>Parameters of the transmission model.
→ scenario → entoData → vector → anopheles
<anopheles
mosquito=string
propInfected=double
propInfectious=double
>
IN THIS ORDER:
| EXACTLY ONE OF:
| | <eir ... />
| | <monthlyEir ... />
| <mosq ... />
| ( <nonHumanHosts ... /> )*
</anopheles>Description of input EIR for one specific vector species in terms of a Fourier approximation to the ln of the EIR during the burn in period
mosquito=stringpropInfected=doubleUnits: Proportion Min: 0 Max: 1
Initial guess of the proportion of mosquitoes which are infected, o: O_v(t) = o*N_v(t). Only used as a starting value.
propInfectious=doubleUnits: Proportion Min: 0 Max: 1
Initial guess of the proportion of mosquitoes which are infectious, s: S_v(t) = s*N_v(t). Used as a starting value and then fit.
→ scenario → entoData → vector → anopheles → eir
<eir
a0=double
a1=double
b1=double
a2=double
b2=double
EIRRotateAngle=double
/>Description of target entomological inoculation rate as a Fourier series. This is used to estimate a suitible vector emergence rate. The annual (target) EIR is thus the exponent of the fourier series with these parameters, with period scaled to 365 days.
a0=doublea1=doubleb1=doublea2=doubleb2=doubleEIRRotateAngle=doubleUnits: radians
→ scenario → entoData → vector → anopheles → monthlyEir
<monthlyEir
annualEIR=double
>
IN THIS ORDER:
| ( <item ... /> ){12,12}
</monthlyEir>Description of target entomological inoculation rate as monthly values plus an annual override (monthly values are scaled to fit the annual EIR described). This is used to estimate a suitible vector emergence rate. The annual (target) EIR is derived from a Fourier series fit to these monthly values (used as a smoothing factor). List should contain twelve entries: January to December.
annualEIR=doubleUnits: Infectious bites per adult per year Min: 0
Scales the monthly values to give this annual innoculation rate.
→ scenario → entoData → vector → anopheles → monthlyEir → item
<item>
double
</item>→ scenario → entoData → vector → anopheles → mosq
<mosq
mosqRestDuration=int
extrinsicIncubationPeriod=int
mosqLaidEggsSameDayProportion=double
mosqSeekingDuration=double
mosqSurvivalFeedingCycleProbability=double
mosqProbBiting=double
mosqProbFindRestSite=double
mosqProbResting=double
mosqProbOvipositing=double
mosqHumanBloodIndex=double
minInfectedThreshold=double
/>Vector species
mosqRestDuration=intextrinsicIncubationPeriod=intmosqLaidEggsSameDayProportion=doublemosqSeekingDuration=doublemosqSurvivalFeedingCycleProbability=doublemosqProbBiting=doublemosqProbFindRestSite=doublemosqProbResting=doublemosqProbOvipositing=doublemosqHumanBloodIndex=doubleThe proportion of resting mosquitoes which fed on human blood during the last feed.
minInfectedThreshold=doubleMin: 0
If less than this many mosquitoes remain infected, transmission is interrupted.
→ scenario → entoData → vector → anopheles → nonHumanHosts
<nonHumanHosts
name=string
mosqRelativeEntoAvailability=double
mosqProbBiting=double
mosqProbFindRestSite=double
mosqProbResting=double
/>Non human host parameters, per type of host (must match up with non-species-specific parameters).
name=stringmosqRelativeEntoAvailability=doublemosqProbBiting=doublemosqProbFindRestSite=doublemosqProbResting=double→ scenario → entoData → vector → nonHumanHosts
<nonHumanHosts
name=string
number=double
/>name=stringUnits: List of elements
Name of this species of non human hosts (must match up with those described per anopheles section)
number=double<drugDescription>
IN THIS ORDER:
| ( <drug ... /> )+
</drugDescription>Drug model parameters
→ scenario → drugDescription → drug
<drug
abbrev=string
>
IN THIS ORDER:
| <PD ... />
| <PK ... />
</drug>Sequence of drug descriptions forming a library of drug parameters.
abbrev=string→ scenario → drugDescription → drug → PD
<PD>
IN THIS ORDER:
| ( <allele ... /> )+
</PD>→ scenario → drugDescription → drug → PD → allele
<allele
name=string
>
IN THIS ORDER:
| <initial_frequency ... />
| <max_killing_rate ... />
| <IC50 ... />
| <slope ... />
</allele>PD parameters per allele, plus initial frequency of each allele.
Note: we assume a one-to-one correspondance of drugs to loci, hence each drug has an independent set of alleles here.
name=string→ scenario → drugDescription → drug → PD → allele → initial_frequency
<initial_frequency>
double
</initial_frequency>Frequency, relative to the total frequency of all alleles for this drug/locus.
→ scenario → drugDescription → drug → PD → allele → max_killing_rate
<max_killing_rate>
double
</max_killing_rate>k1 — Maximal parasite killing rate.
→ scenario → drugDescription → drug → PD → allele → IC50
<IC50>
double
</IC50>Half maximal effect concentration.
→ scenario → drugDescription → drug → PD → allele → slope
<slope>
double
</slope>n — Slope of the concentration effect curve
→ scenario → drugDescription → drug → PK
<PK>
IN THIS ORDER:
| <negligible_concentration ... />
| <half_life ... />
| <vol_dist ... />
</PK>→ scenario → drugDescription → drug → PK → negligible_concentration
<negligible_concentration>
double
</negligible_concentration>Concentration below which drug's effects are deemed negligible and can be removed from simulation.
→ scenario → drugDescription → drug → PK → half_life
<half_life>
double
</half_life>Used to calculate elimination rate (which is: ln(2) / half_life).
→ scenario → drugDescription → drug → PK → vol_dist
<vol_dist>
double
</vol_dist>Volume of Distribution
<model>
IN THIS ORDER:
| <ModelOptions ... />
| <clinical ... />
| <human ... />
| <parameters ... />
</model>Encapsulation of all parameters which describe the model according to which fitting is done.
→ scenario → model → ModelOptions
<ModelOptions>
IN THIS ORDER:
| ( <option ... /> )*
</ModelOptions>All model options (bug fixes, choices between models, etc.).
The list of recognised options can be found in the code at:
include/util/ModelOptions.h and should also be in the wiki.
<clinical
healthSystemMemory=int
>
IN THIS ORDER:
| [ <NonMalariaFevers ... /> ]
</clinical>Description of clinical parameters.
This is related to the health-system description, but contains data which can't be changed as part of an intervention and is not restricted to treatment.
healthSystemMemory=intUnits: Time steps Min: 1 Max: 100
Follow-up period during which a recurrence is considered to be a treatment failure
→ scenario → model → clinical → NonMalariaFevers
<NonMalariaFevers>
IN THIS ORDER:
| <incidence ... />
| <prNeedTreatment ... />
</NonMalariaFevers>Description of non-malaria fever incidence. Non-malaria fevers are only modelled if the NON_MALARIA_FEVERS option is used.
→ scenario → model → clinical → NonMalariaFevers → incidence
<incidence
[ interpolation=("none" or "linear") ] DEFAULT VALUE linear
>
IN THIS ORDER:
| ( <group ... /> )+
</incidence>Probability that a non-malaria fever occurs given that no concurrent malaria fever occurs.
interpolation=("none" or "linear")Units: none Default value: linear
Interpolation algorithm. Normally it is desirable for age-based values to be continuous w.r.t. age. By default linear interpolation is used.
With all algorithms except "none", the age groups are converted to a set of points centred within each age range. Extra points are added at each end (zero and infinity) to keep value constant at both ends of the function. A zero-length age group may be used as a kind of barrier to adjust the distribution; e.g. with age group boundaries at 15, 20 and 25 years, a (linear) spline would be drawn between ages 17.5 and 22.5, whereas with boundaries at 15, 20 and 20 years, a spline would be drawn between ages 17.5 and 20 years (may be desired if individuals are assumed to reach adult size at 20).
Algorithms:
- none: input values are used directly
- linear: straight lines (on an age vs. value graph) are used to interpolate data points.
→ scenario → model → clinical → NonMalariaFevers → prNeedTreatment
<prNeedTreatment
[ interpolation=("none" or "linear") ] DEFAULT VALUE linear
>
IN THIS ORDER:
| ( <group ... /> )+
</prNeedTreatment>Probability that a non-malaria fever needs treatment with antibiotics (assuming fever is not induced by malaria, although concurrent parasites are possible).
interpolation=("none" or "linear")Units: none Default value: linear
Interpolation algorithm. Normally it is desirable for age-based values to be continuous w.r.t. age. By default linear interpolation is used.
With all algorithms except "none", the age groups are converted to a set of points centred within each age range. Extra points are added at each end (zero and infinity) to keep value constant at both ends of the function. A zero-length age group may be used as a kind of barrier to adjust the distribution; e.g. with age group boundaries at 15, 20 and 25 years, a (linear) spline would be drawn between ages 17.5 and 22.5, whereas with boundaries at 15, 20 and 20 years, a spline would be drawn between ages 17.5 and 20 years (may be desired if individuals are assumed to reach adult size at 20).
Algorithms:
- none: input values are used directly
- linear: straight lines (on an age vs. value graph) are used to interpolate data points.
<human>
IN THIS ORDER:
| <availabilityToMosquitoes ... />
| [ <weight ... /> ]
</human>Parameters of host models.
→ scenario → model → human → availabilityToMosquitoes
<availabilityToMosquitoes
[ interpolation=("none" or "linear") ] DEFAULT VALUE linear
>
IN THIS ORDER:
| ( <group ... /> )+
</availabilityToMosquitoes>By age group data on availability of humans to mosquitoes relative to an adult.
interpolation=("none" or "linear")Units: none Default value: linear
Interpolation algorithm. Normally it is desirable for age-based values to be continuous w.r.t. age. By default linear interpolation is used.
With all algorithms except "none", the age groups are converted to a set of points centred within each age range. Extra points are added at each end (zero and infinity) to keep value constant at both ends of the function. A zero-length age group may be used as a kind of barrier to adjust the distribution; e.g. with age group boundaries at 15, 20 and 25 years, a (linear) spline would be drawn between ages 17.5 and 22.5, whereas with boundaries at 15, 20 and 20 years, a spline would be drawn between ages 17.5 and 20 years (may be desired if individuals are assumed to reach adult size at 20).
Algorithms:
- none: input values are used directly
- linear: straight lines (on an age vs. value graph) are used to interpolate data points.
→ scenario → model → human → weight
<weight
multStdDev=double
>
IN THIS ORDER:
| ( <group ... /> )+
</weight>By age group data on human weight (mass).
multStdDev=doubleUnits: None Min: 0
Each human is assigned a weight multiplier from a normal distribution with mean 1 and this standard deviation at birth. His/her weight is this multiplier times the mean from age distribution. A standard deviation of zero for no heterogeneity is valid; a rough value from Tanzanian data is 0.14.
→ scenario → model → parameters
<parameters
interval=int
iseed=int
latentp=int
>
IN THIS ORDER:
| ( <parameter ... /> )+
</parameters>Parameters of the epidemiological model
interval=intUnits: Days
Simulation step
iseed=intUnits: Number
Seed for RNG
latentp=intUnits: Time steps Min: 0 Max: 20
pre-erythrocytic latent period, in time steps
→ scenario → model → parameters → parameter
<parameter
name=string
number=int
value=double
include=boolean
/>name=stringUnits: string
Name of parameter
number=intUnits: Number Min: 1 Max: 100
Reference number of input parameter
value=doubleUnits: Number Min: 0
Parameter value
include=booleanUnits: Number Min: 0 Max: 1
True if parameter is to be sampled in optimization runs. Not used in simulator app.