Node demographics report (ReportNodeDemographics.csv)¶
The node demographics report is a CSV-formatted report that provides population information stratified by node. For each time step, the report will collect data on each node and age bin.
The report name is ReportNodeDemographics.csv, and is produced via the libReportNodeDemographics.dll file. See Custom reporters for information on using dynamic link library (DLL) files.
Configuration¶
The following parameters need to be configured to generate the report:
Parameter name |
Data type |
Min |
Max |
Default |
Description |
|---|---|---|---|---|---|
IP_Key_To_Collect |
string |
NA |
NA |
(empty string) |
The name of the IndividualProperty key to stratify by; an empty string implies ‘do not stratify by IP.’ |
Age_Bins |
Array of integers |
0 |
MAX_HUMAN_AGE |
[40, 80, 125] |
The Age Bins (in years) to aggregate within and report; an empty array implies ‘do not stratify by age.’ |
Stratify_By_Gender |
boolean |
0 |
1 |
1 |
Set to true (1) to stratify by gender; a value of 0 will not stratify by gender. |
Output file data¶
The report will contain the following output data, divided between stratification columns and data columns.
Stratification columns¶
Parameter |
Data type |
Description |
|---|---|---|
Time |
integer |
The day of the simulation that the data was collected. |
NodeID |
string |
The External ID of the node for the data in the row in the report. |
Gender |
enum |
Possible values are M or F; the gender of the individuals in the row in the report. |
AgeYears |
integer |
The max age in years of the bin for the individuals in the row in the report. |
IndividualProp |
string |
The value of the IP for the individuals in the row in the report. |
Data columns¶
Parameter |
Data type |
Description |
|---|---|---|
NumIndividuals |
integer |
The number of individuals that meet the stratification values. |
NumInfected |
integer |
The number of infected individuals that meet the stratification values and are infected. |
Example¶
The following is an example of ReportNodeDemographics.csv.
Time |
NodeID |
Gender |
AgeYears |
IndividualProp=Risk |
NumIndividuals |
NumInfected |
|---|---|---|---|---|---|---|
0 |
2 |
M |
40 |
High |
1455 |
0 |
0 |
2 |
M |
40 |
Low |
627 |
0 |
0 |
2 |
M |
125 |
High |
47 |
0 |
0 |
2 |
M |
125 |
Low |
24 |
0 |
0 |
2 |
F |
40 |
High |
1390 |
0 |
0 |
2 |
F |
40 |
Low |
609 |
0 |
0 |
2 |
F |
125 |
High |
43 |
0 |
0 |
2 |
F |
125 |
Low |
22 |
0 |
0 |
1 |
M |
40 |
High |
459 |
0 |
0 |
1 |
M |
40 |
Low |
1630 |
0 |
0 |
1 |
M |
125 |
High |
18 |
0 |
0 |
1 |
M |
125 |
Low |
47 |
0 |
0 |
1 |
F |
40 |
High |
439 |
0 |
0 |
1 |
F |
40 |
Low |
1597 |
0 |
0 |
1 |
F |
125 |
High |
17 |
0 |
0 |
1 |
F |
125 |
Low |
67 |
0 |
1 |
2 |
M |
40 |
High |
1455 |
0 |
1 |
2 |
M |
40 |
Low |
627 |
0 |
1 |
2 |
M |
125 |
High |
47 |
0 |
1 |
2 |
M |
125 |
Low |
24 |
0 |
1 |
2 |
F |
40 |
High |
1390 |
0 |
1 |
2 |
F |
40 |
Low |
609 |
0 |
1 |
2 |
F |
125 |
High |
43 |
0 |
1 |
2 |
F |
125 |
Low |
22 |
0 |
1 |
1 |
M |
40 |
High |
459 |
0 |
1 |
1 |
M |
40 |
Low |
1630 |
26 |
1 |
1 |
M |
125 |
High |
18 |
0 |
1 |
1 |
M |
125 |
Low |
47 |
0 |
1 |
1 |
F |
40 |
High |
439 |
1 |
1 |
1 |
F |
40 |
Low |
1597 |
17 |
1 |
1 |
F |
125 |
High |
17 |
0 |
1 |
1 |
F |
125 |
Low |
67 |
0 |