BinnedReport#
The binned output report (BinnedReport.json) is a JSON-formatted file where the channel data has been sorted into age bins. It is very similar to an inset chart, however, with the binned report all channels are broken down into sub-channels (bins) based on age. For example, instead of having a single prevalence channel, you might have prevalence in the “0-3 years old bin” and the “4-6 years old bin, and so forth.
To generate the binned report, set the Enable_Demographics_Reporting configuration parameter to 1. The demographics summary output report will also be generated.
The file contains a header and a channels section.
Header#
The header section contains the following parameters.
Parameter |
Data type |
Description |
||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
DateTime |
string |
The time stamp indicating when the report was generated. |
||||||||||||||||||
DTK_Version |
string |
The version of EMOD used. |
||||||||||||||||||
Report_Type |
string |
The type of output report. |
||||||||||||||||||
Report_Version |
string |
The format version of the report. |
||||||||||||||||||
Timesteps |
integer |
The number of time steps in this simulation. |
||||||||||||||||||
Channels |
integer |
The number of channels in the simulation. |
||||||||||||||||||
Subchannel_Metadata |
nested JSON object |
Metadata that describes the bins and axis information. The metadata includes the following parameters:
|
Channels#
The channels section contains the following parameters.
Parameter |
Data type |
Description |
|---|---|---|
<Channel_Title> |
string |
The title of the particular channel. |
Units |
string |
The units used for this channel. |
Data |
array |
A list of the channel data at each time step. |
Infected |
integer |
The number of individuals who are currently infected in that age bin on that day. |
New Infections |
integer |
The number of individuals who became infected on that day in that age bin. |
Population |
integer |
The total number of individuals in that age bin on that day. |
Example#
The following is an example of an HIV BinnedReport.json file.
{
"Header": {
"DateTime": "Tue Mar 21 13:46:06 2023",
"DTK_Version": "Malaria-Ongoing (bb265ad) Dec 21 2020 11:15:31",
"Report_Version": "2.1",
"Timesteps": 10,
"Base_Year": 1995,
"Subchannel_Metadata": {
"AxisLabels": [ [ "Age" ] ],
"NumBinsPerAxis": [ [ 21 ] ],
"ValuesPerAxis": [
[
[
1825, 3650, 5475, 7300, 9125,
10950, 12775, 14600, 16425, 18250,
20075, 21900, 23725, 25550, 27375,
29200, 31025, 32850, 34675, 36500,
999999
]
]
],
"MeaningPerAxis": [
[
[ "<5", "5-9", "10-14", "15-19", "20-24",
"25-29", "30-34", "35-39", "40-44", "45-49",
"50-54", "55-59", "60-64", "65-69", "70-74",
"75-79", "80-84", "85-89", "90-94", "95-99",
">100"
]
]
]
},
"Channels": 3
},
"Channels": {
"Infected": {
"Units": "",
"Data": [
[0, 15, 15, 15, 15, 15, 15, 15, 15, 15],
[0, 10, 10, 10, 10, 10, 10, 10, 10, 10],
[0, 15, 15, 15, 15, 15, 15, 15, 15, 15],
[0, 7, 7, 7, 7, 7, 7, 7, 7, 7],
[0, 4, 4, 4, 4, 4, 4, 4, 4, 4],
[0, 7, 7, 7, 7, 7, 7, 7, 7, 7],
[0, 4, 4, 4, 4, 4, 4, 4, 4, 4],
[0, 3, 3, 3, 3, 3, 3, 3, 3, 3],
[0, 3, 3, 3, 3, 3, 3, 3, 3, 3],
[0, 4, 4, 4, 4, 4, 4, 4, 4, 4],
[0, 3, 3, 3, 3, 3, 3, 3, 3, 3],
[0, 6, 6, 6, 6, 6, 6, 6, 6, 6],
[0, 1, 1, 1, 1, 1, 1, 1, 1, 1],
[0, 1, 1, 1, 1, 1, 1, 1, 1, 1],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 1, 1, 1, 1, 1, 1, 1, 1, 1],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
]
},
"New Infections": {
"Units": "",
"Data": [
[0, 15, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 10, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 15, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 7, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 4, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 7, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 4, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 3, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 3, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 4, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 3, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 6, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 1, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 1, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 1, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
]
},
"Population": {
"Units": "",
"Data": [
[36, 36, 36, 36, 36, 36, 36, 36, 36, 36],
[17, 17, 17, 17, 17, 17, 17, 17, 17, 17],
[20, 20, 20, 20, 20, 20, 20, 20, 20, 20],
[18, 18, 18, 18, 18, 18, 18, 18, 18, 18],
[11, 11, 11, 11, 11, 11, 11, 11, 11, 11],
[10, 10, 10, 10, 10, 10, 10, 10, 10, 10],
[ 9, 9, 9, 9, 9, 9, 9, 9, 9, 9],
[ 9, 9, 9, 9, 9, 9, 9, 9, 9, 9],
[11, 11, 11, 11, 11, 11, 11, 11, 11, 11],
[ 8, 8, 8, 8, 8, 8, 8, 8, 8, 8],
[ 8, 8, 8, 8, 8, 8, 8, 8, 8, 8],
[ 8, 8, 8, 8, 8, 8, 8, 8, 8, 8],
[ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2],
[ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2],
[ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2],
[ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 1, 1, 1, 1, 1, 1, 1, 1, 1, 1],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
]
}
}
}