Skip to content

Latest commit

 

History

History
26 lines (26 loc) · 6.73 KB

output_file_dictionary_overview.md

File metadata and controls

26 lines (26 loc) · 6.73 KB

Table: PopART-IBM output file dictionary

Macro Filename Description Default Dependencies
WRITE_ANNUAL_PARTNERSHIPS_OUTPUTS Annual_partnerships_outputs* Annual summaries of partnership data from the start until end of the simulation (cross sectional measures are at 31st Dec of the year in question, incident measures are over the year in question). Model outputs stratified by risk gp and whether partnership is cross-community: mean number of current partners; mean number of current serodiscordant partners; mean number of new partners (this year); mean number of lifetime partners. Model outputs stratified by sex, age gp and whether partnership is cross-community: mean number of current partners; mean number of new partners (this year); mean number of lifetime partners. 0 -
WRITE_HIVSURVIVAL_OUTPUT HIVsurvival_individualdata* At the end of the simulation, outputs information on all HIV-positive individuals ever in the simulation (DoB, DoD, sex, date first on ART etc) 0 -
WRITE_DEBUG_DEMOGRAPHICS_NBIRTHS_NEWADULTS_DEATHS NBirthsNNewAdultsNdeaths* Outputs the number of births, new adults and deaths each year. For comparison with output of files produced by print_one_year_age_groups_including_kids() which allow us to see number of each of these in a year. Used for model validation. 0 -
WRITE_DEBUG_DEMOGRAPHICS_AGE_DISTRIBUTION_BY_GENDER Age_distribution_check* Annually outputs the age distribution of the adult population by sex and UNPD 5 year age groups (10-14,15-19,20-24,…80+), and the age distribution of new deaths by sex and UNPD 5 year age groups. Also outputs annually the cumulative total number of deaths. Used for model validation. 0 -
WRITE_DEBUG_DEMOGRAPHICS_AGE_DISTRIBUTION_ONEYEARINCKIDS OneYearAgeGp.csv Annually outputs the age distribution of the population in one year age groups: kids (aged 0-13), males aged 14+ and females aged 14+. Used for model validation. 0 -
WRITE_DEBUG_DEMOGRAPHICS_LIFE_EXPECTANCY LifeExpectancy_[COUNTRY].csv Outputs for each run the average life years lived of people born in 5 year cohorts (e.g. 1900-1904, 1905-1909,…). Used for model validation by comparison to UNPD or other demographic estimates. 0 Requires that the parameter end_time_simul is set to 2100 or later (thereby providing enough time for people to die).
WRITE_DEBUG_INITIAL_SPVL_DISTRIBUTION DEBUG_HIV_initialSPVLdistribution* Outputs the environmental (SPVL_num_E) and inherited (SPVL_num_G) components of the SPVL of each seeded HIV infection and their corresponding SPVL category. Used to validate SPVL of seeded infections. 0 -
WRITE_DEBUG_CD4_AFTER_SEROCONVERSION DEBUG_HIV_CD4_after_seroconversion* Outputs the ID, CD4 category and SPVL category of each infected individual during the simulation. Used to validate that CD4 distribution by SPVL category generated by model is as expected. 0 -
WRITE_DEBUG_HIV_DURATION DEBUG_HIVduration* For each HIV+ ART-naïve individual who dies from AIDS-related illness, stores the date of death, date of infection, SPVL and CD4 categories, and what their ART status was at death. Used for model validation of HIV duration. 0 -
WRITE_DEBUG_HIV_DURATION_KM DEBUG_HIVduration_KM* Same as WRITE_DEBUG_HIV_DURATION, but writes output whenever an ART-naive HIV+ individual dies of AIDS-related illness, non-HIV causes, or starts ART for the first time. Output is also recorded at the end of the simulation for those HIV+ individuals who have not yet done any of those. The reason for recodring is also stored. Used for model validation of HIV duration. 0 -
WRITE_DEBUG_HIV_STATES DEBUG_HIVstates_population* Each year from start of HIV epidemic, (until DEBUG_MAX_HIV_STATE_OUTPUT_TIME, after which output is every 10 years to reduce file size), outputs key cascade variables for each HIV+ individual. Used to validate the ART cascade. 0 -
WRITE_DEBUG_ART_STATE DEBUG_ART_population_* Each year, outputs the current and cumulative (i.e. ever) number of people in each stage of the ART cascade. Used to validate the ART cascade 0 -
WRITE_ART_STATUS_BY_AGE_SEX ART_status_by_age_sex* Write totals of individuals in each HIV_status and ART_status, stratified by sex and year of age for each time step after HIV is introduced in the simulation. 0 -
WRITE_DEBUG_CHIPS_STATES CHIPS_outputs_annual* Outputs the number of people who were visited by CHiPs (by sex and one year age group) for each stage of the ART cascade in a given calendar year 0 -
WRITE_CALIBRATION Calibration_output_* Succinct file for saving only the data essential for calibration (to reduce computation time). Typically this is age and sex-stratified prevalence and HIV care cascade data at select time points when there is data to calibrate to (e.g. CHiPS, PC or DHS data). File contains one row per simulation. 1 -
WRITE_EVERYTIMESTEP Timestep_outputs* and Timestep_outputs_Pconly* Outputs per-timestep (1/48th of a year by default) summaries from time of HIV seeding until end of the simulation. 1 -
WRITE_PHYLOGENETICS_OUTPUT phylogenetic_transmission* and phylogenetic_individualdata* Output complete transmission tree for a single patch. Transmission events are summarised in *transmission* file and individuals in the simulation are summarised in the *individual* file. 0 Requires the specification of macro PHYLO_PATCH to determine which patch is output.
WRITE_PARTNERSHIP_NETWORK_SNAPSHOT Partnership_network_* Output the sexual network at fixed times to allow network plots. The years at which partnerships are output are hard-coded within main.c. 0 -
WRITE_PARTNERS_OUTSIDE_COMMUNITY Partner_outside_inside_patch0.csv Annually outputs the number and proportion of partnerships where the partner lives outside the patch by sex and risk group 0 -
WRITE_HAZARDS Hazards_* Outputs between 2014 and 2015 the hazard, and transmission-related information from the seropositive partner, from every serodiscordant partnership in patch 0. Used to validate that hazard is calculated correctly for given serodiscordant partnership. 0 -
WRITE_PARTNERSHIPS_AT_PC0 Distr_n_lifetime_partners* and Distr_n_partners_lastyear* At the start of PC0, output the distribution of the number of lifetime/last year partners respectively of all individuals currently alive, by sex, age group and risk group 0 -
WRITE_COST_EFFECTIVENESS_OUTPUT Cost_effectiveness_* Output files used in the cost-effectiveness analysis 0 -
WRITE_TREATS_OUTPUT TREATS_* Output files used for the modelling team on the TREATS trial 0 -