ReportDrugStatus#

The drug status report (ReportDrugStatus.csv) provides status information on the drugs that an individual has taken or is waiting to take. Because the report provides information for each drug, for each individual, and for each time step, you may want to use the Start_Day and End_Day parameters to limit the size of the output file. You cannot filter based on the demographics parameter IndividualProperties.

Configuration#

To generate this report, configure the following parameters in the custom_report.json file:

Parameter name

Data type

Min

Max

Default

Description

End_Day

float

0

3.40E+38

3.40E+38

The day to stop collecting data for the report.

Start_Day

float

0

3.40E+38

0

The day to start collecting data for the report.

{
    "Reports": [
        {
            "Start_Day": 300,
            "End_Day": 900,
            "class": "ReportDrugStatus"
        }
    ],
    "Use_Defaults": 1
}

Output data#

The report contains the following stratification columns:

Parameter

Data type

Description

Time

integer

The day of the simulation on which the data was collected for the data in the row.

NodeID

string

The external ID of the node.

The report contains the following data columns:

Parameter

Data type

Description

IndividualID

integer

The ID of the individual who received the drug.

Gender

enum

The gender of the individual. Possible values are M or F.

AgeYears

integer

The max age in years of the age bin for the individual.

Infected

boolean

A true value (1) indicates the individual is infected and a false value (0) indicates the individual is not infected.

Infectiousness

float

A value from 0 to 1 that indicates how infectious an individual is, with 0 = not infectious and 1 = very infectious. This is the probability that an individual will infect a mosquito during a successful blood meal.

DrugName

string

The name of the drug indicated in the intervention (Malaria_Drug_Params in config.json). Depending on the intervention, this might be a concatenated value when an individual takes multiple pills in one dose.

CurrentEfficacy

float

The current efficacy of the drug(s). The efficacy is determined by the selected PKPD model; see Antimalarial drugs for more information.

NumRemainingDoses

integer

The number of remaining doses the individual will receive.

Example#

The following is an example of ReportDrugStatus.csv.

Time

NodeID

IndividualID

Gender

AgeYears

Infected

Infectiousness

DrugName

CurrentEfficacy

NumRemainingDoses

40

7

8

F

6610.81

1

0

TestDrugA+TestDrugB

0.25125

1

40

7

15

M

4807.43

1

0

TestDrugA+TestDrugB

0.25125

1

40

7

22

F

5834.48

1

0

TestDrugA+TestDrugB

0.25125

1

40

6

392

M

11910

1

0

TestDrugB

0.239501

1

40

6

399

M

5829.22

1

0

TestDrugA

0.015448

0

40

6

399

M

5829.22

1

0

TestDrugB

0.239501

1

40

6

420

F

13548.3

1

0

TestDrugB

0.239501

1

40

6

427

F

3751.18

1

0

TestDrugA

0.015448

0

40

6

427

F

3751.18

1

0

TestDrugB

0.239501

1

40

5

6985

F

11397.3

1

0

TestDrugB

0.239501

1

40

5

6992

M

712.512

1

0

TestDrugB

0.239501

1

40

5

6999

M

11219.9

1

0

TestDrugB

0.239501

1

40

4

5

F

2423.01

1

0

TestDrugB

0.239501

1

40

4

12

F

7146.54

1

0

TestDrugB

0.239501

1

40

4

19

F

8099.7

1

0

TestDrugB

0.239501

1

40

4

26

F

16387.3

1

0

TestDrugB

0.239501

1

40

4

33

F

11535

1

0

TestDrugB

0.239501

1

40

4

40

M

6686.1

1

0

TestDrugB

0.239501

1