Skip to content

RelationshipStart

The relationship formation report (RelationshipStart.csv) provides information about each relationship and its members, evaluated at the time of relationship formation. The report includes the relationship type, start time, scheduled end time, and detailed information about each participant: ID, gender, age, infection status, circumcision status for males, co-infections, number of relationships (active, recent, lifetime), and individual properties. The male in the relationship is indicated on the report as participant "A", and the female as participant "B".

Configuration

To generate the report, the following parameters must be configured in the config.json file:

Parameter Data type Min Max Default Description
Report_Relationship_Start boolean NA NA 0 Set this to 1 to generate the report.
Report_Relationship_Start_Start_Year float 1900 2200 1900 Simulation time in years to start collecting data.
Report_Relationship_Start_End_Year float 1900 2200 2200 Simulation time in years to stop collecting data.
Report_Relationship_Start_Max_Age_Years float 0 9.3228e+35 9.3228e+35 The age that of one of the partners must be less than or equal to for the relationship to be reported.
Report_Relationship_Start_Min_Age_Years float 0 9.3228e+35 0 The age that of one of the partners must be greater than or equal to for the relationship to be reported.
Report_Relationship_Start_Node_IDs_Of_Interest array 0 2.14748e+09 [] Data will be collected for the nodes in this list.
Report_Relationship_Start_Include_HIV_Disease_Statistics boolean NA NA 1 When set to 1, the report will include information on CD4 count, viral load, disease stage, HIV positivity, and HIV testing results for each partner in the relationship.
Report_Relationship_Start_Include_Other_Relationship_Statistics boolean NA NA 1 When set to 1, the report will include information on the number of active and lifetime relationships of each type (Transitory, Informal, Marital, and Commercial) for each partner in the relationship, as well as total relationships in the past six month and total lifetime relationships. Additionally, a bitmask column will indicate which types of concurrent relationships are allowed; these are configured using the Concurrency_Configuration parameter in the demographics file—see Demographics parameters for more information.
Report_Relationship_Start_Individual_Properties array of strings NA NA [] A list of individual property (IP) keys that will be included in the report as applicable to each partner at the start of the relationship. One column will be added to the report for each partner, for each key in the list. Specify the IP keys by adding an IndividualProperties parameter in the demographics file. See Individual and node properties for details on setting individual properties.
Report_Relationship_Start_Must_Have_IP_Key_Value string NA NA "" A Key:Value pair that one of the partners must have for the relationship to be reported. Empty string means don't look at individual properties. For more information, see Individual and node properties.
Report_Relationship_Start_Must_Have_Intervention string NA NA "" The name of an intervention that the one of the partners must have in order for the relationship to be reported. Empty string means don't look at the interventions. For more information, see Individual-level interventions.
{
    "Report_Relationship_Start": 1,
    "Report_Relationship_Start_Start_Year": 1900,
    "Report_Relationship_Start_End_Year": 2200,
    "Report_Relationship_Start_Max_Age_Years": 60,
    "Report_Relationship_Start_Min_Age_Years": 20,
    "Report_Relationship_Start_Node_IDs_Of_Interest": [ 1, 2, 3 ],
    "Report_Relationship_Start_Include_Other_Relationship_Statistics": 1,
    "Report_Relationship_Start_Individual_Properties": ["InterventionStatus"],
    "Report_Relationship_Start_Must_Have_IP_Key_Value": "Risk:HIGH",
    "Report_Relationship_Start_Must_Have_Intervention": "",
}

Output file data

The output report will contain the following information.

Data channel Data type Description
Rel_ID integer A unique identifier for the relationship, different from the IDs of the participants.
Rel_start_time float The time (in days) during the simulation when the relationship started.
Rel_scheduled_end_time float The time (in days) during the simulation when the relationship was scheduled to end. The duration of the relationship is dependent on the relationship type; configure by updating the Duration_Weibull_Heterogeneity and Duration_Weibull_Scale parameters in the demographics file. See Demographics parameters for details.
Rel_type (0 = TRANSITORY; 1 = INFORMAL; 2 = MARITAL; 3 = COMMERCIAL) integer The type of relationship between individuals A and B. Values for 0-3 as indicated in the header.
Is_rel_outside_PFA character Indicates whether or not the relationship was created by the normal process using the Pair Forming Algorithm (PFA), where "F" indicates the relationship was created using the PFA, and "T" indicates the relationship was created using the StartNewRelationship intervention.
Original_node_ID integer The ID of the node where the relationship started.
Current_node_ID integer The ID of the node where the participants currently reside.
<A or B>_ID integer The unique numerical identifier for the individual. There is a column for each partner.
<A or B>_is_infected boolean Indicates whether or not the individual is infected: 0 for not infected, 1 for infected. There is a column for each partner.
<A or B>_gender boolean The gender of the individual: 0 is for male, 1 is for female. There is a column for each partner.
<A or B>_age float The age of the individual in years. There is a column for each partner.
<A or B>_IP=<'IP_Key'> depends on IP key For each individual property key in the Report_Relationship_Start_Individual_Properties parameter list, a column will be added. The value will be the value for the IP key that this partner has at this time. There is a column for each partner. See Configuration for additional details on designating the IP keys.
<A or B>_total_num_active_rels integer If the Report_Relationship_Start_Include_Other_Relationship_Statistics parameter is set to 1, this column will be included, indicating the total number of active relationships the individual is currently in. There is a column for each partner.
<A or B>_num_active_TRANSITORY_rels integer If the Report_Relationship_Start_Include_Other_Relationship_Statistics parameter is set to 1, this column will be included, indicating the total number of transitory relationships the individual is currently in. There is a column for each partner.
<A or B>_num_active_INFORMAL_rels integer If the Report_Relationship_Start_Include_Other_Relationship_Statistics parameter is set to 1, this column will be included, indicating the total number of informal relationships the individual is currently in. There is a column for each partner.
<A or B>_num_active_MARITAL_rels integer If the Report_Relationship_Start_Include_Other_Relationship_Statistics parameter is set to 1, this column will be included, indicating the total number of marital relationships the individual is currently in. There is a column for each partner.
<A or B>_num_active_COMMERCIAL_rels integer If the Report_Relationship_Start_Include_Other_Relationship_Statistics parameter is set to 1, this column will be included, indicating the total number of commercial relationships the individual is currently in. There is a column for each partner.
<A or B>_num_lifetime_rels integer If the Report_Relationship_Start_Include_Other_Relationship_Statistics parameter is set to 1, this column will be included, indicating the total number of relationships the individual has had during their lifetime. There is a column for each partner.
<A or B>_num_rels_last_6_mo integer If the Report_Relationship_Start_Include_Other_Relationship_Statistics parameter is set to 1, this column will be included, indicating the total number of relationships the individual has had in the last six months. There is a column for each partner.
<A or B>_extra_relational_bitmask integer If the Report_Relationship_Start_Include_Other_Relationship_Statistics parameter is set to 1, this column will be included, indicating which types of relationships that individual is allowed to have when they have more than one active relationship. These values are configured using the Concurrency_Configuration parameter in the demographics file—see Demographics parameters for more information. These values can be updated when an individual migrates or has a value change in an individual property. The values are encoded in a 3-digit bitmask. In order, the digits correspond to Commercial (C), Marital (M), Informal (I), and Transitory (T) relationships. See the bitmask reference table below.
<A or B>_is_circumcised boolean Indicates whether or not the individual is circumcised: 0 for not circumcised, 1 for circumcised. There is a column for each partner.
<A or B>_has_STI_coinfection boolean Indicates whether or not the individual has an STI co-infection: 0 if they do not have an STI co-infection, 1 if they do have an STI co-infection. There is a column for each partner.
<A or B>_is_superspreader boolean Indicates whether or not the individual is a super-spreader: 0 if they are not a super-spreader, 1 if they are a super-spreader. This status is configured using the Probability_Person_Is_Behavioral_Super_Spreader parameter in the demographics file—see Demographics parameters for more information. There is a column for each partner.
<A or B>_CD4_count float If the Report_Relationship_Start_Include_HIV_Disease_Statistics parameter is set to 1, this column will be included, indicating the CD4 count for each partner. There is a column for each partner. Note: this is only included in HIV simulations.
<A or B>_viral_load float This channel is not currently supported. If the Include_HIV_Disease_Statistics parameter is set to 1, this column will be included, where -1 indicates that the partner is not infected, 1000 indicates that the partner is infected. There is a column for each partner. Note: this is only included in HIV simulations.
<A or B>_HIV_disease_stage float If the Report_Relationship_Start_Include_HIV_Disease_Statistics parameter is set to 1, this column will be included, indicating the stage of infection for each individual. There is a column for each partner. Possible values are:

0 = Uninfected
1 = Untreated acute HIV infection
2 = Untreated latent HIV infection
3 = Untreated late/AIDS stage
* 4 = On ART

Note: this only included in HIV simulations.
<A or B>_HIV_Tested_Positive boolean If the Report_Relationship_Start_Include_HIV_Disease_Statistics parameter is set to 1, this column will be included, indicating whether or not the partner has ever tested positive for HIV using the results of the HIVRapidHIVDiagnostic campaign parameter. 0 indicates the partner has never tested positive, 1 indicates they have tested positive. See HIVRapidHIVDiagnostic for configuration details. There is a column for each partner. Note: this is only included in HIV simulations.
<A or B>_HIV_Received_Results string If the Include_HIV_Disease_Statistics parameter is set to 1, this column will be included, indicating the results received by the individual from the latest HIV test using the HIVRapidHIVDiagnostic campaign parameter. Possible values are:

UNKNOWN: Indicates that the individual did not receive their results.

NEGATIVE: Indicates that the most recent results were negative.

POSITIVE: Indicates that the most recent results were positive.

Whether or not the an individual receives their results is determined by the Probability_Received_Results campaign parameter, see HIVRapidHIVDiagnostic for configuration details. There is a column for each partner.

Bitmask reference for <A or B>_extra_relational_bitmask:

Relationships allowed Binary Decimal Value
None 0000 0
T 0001 1
I 0010 2
I, T 0011 3
M 0100 4
M, T 0101 5
M, I 0110 6
M, I, T 0111 7
C 1000 8
C, T 1001 9
C, I 1010 10
C, I, T 1011 11
C, M 1100 12
C, M, T 1101 13
C, M, I 1110 14
C, M, I, T 1111 15

Example

The following is an example of a RelationshipStart.csv report:

Rel_ID Rel_start_time Rel_scheduled_end_time Rel_type (0 = TRANSITORY; 1 = INFORMAL; 2 = MARITAL; 3 = COMMERCIAL) Is_rel_outside_PFA Original_node_ID Current_node_ID A_ID A_is_infected A_gender A_age A_IP='Risk' A_total_num_active_rels A_num_active_TRANSITORY_rels A_num_active_INFORMAL_rels A_num_active_MARITAL_rels A_num_active_COMMERCIAL_rels A_num_lifetime_rels A_num_rels_last_6_mo A_extra_relational_bitmask A_is_circumcised A_has_STI_coinfection A_is_superspreader B_ID B_is_infected B_gender B_age B_IP='Risk' B_total_num_active_rels B_num_active_TRANSITORY_rels B_num_active_INFORMAL_rels B_num_active_MARITAL_rels B_num_active_COMMERCIAL_rels B_num_lifetime_rels B_num_rels_last_6_mo B_extra_relational_bitmask B_is_circumcised B_has_STI_coinfection B_is_superspreader A_CD4_count B_CD4_count A_viral_load B_viral_load A_HIV_disease_stage B_HIV_disease_stage A_HIV_Tested_Positive B_HIV_Tested_Positive A_HIV_Received_Results B_HIV_Received_Results
883697 14235.2 14282.5 3 F 11 11 473090 0 0 19.6729 LOW 1 0 0 0 1 5 5 8 0 0 0 306143 1 1 33.0387 LOW 1 0 0 0 1 20 1 8 0 0 0 540.55 45.9653 -1 10000 0 2 0 0 UNKNOWN UNKNOWN
883713 14235.2 14240.1 3 F 11 11 291007 1 0 34.0772 MEDIUM 2 0 0 0 2 13 2 8 0 0 0 247942 1 1 37.0004 LOW 3 0 0 0 3 19 3 8 0 0 0 239.501 58.8507 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883714 14235.2 14286.4 3 F 11 11 291007 1 0 34.0772 MEDIUM 3 0 0 0 3 14 3 8 0 0 0 306143 1 1 33.0387 LOW 4 0 0 0 4 23 4 8 0 0 0 239.501 45.9653 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883730 14235.2 14237.1 3 F 10 10 230518 1 0 38.2504 LOW 1 0 0 0 1 42 1 8 0 0 0 238647 1 1 37.6543 MEDIUM 1 0 0 0 1 36 1 8 0 0 0 237.113 50.3523 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883736 14235.2 14239.8 3 F 10 10 447988 1 0 21.6921 MEDIUM 3 0 0 0 3 8 3 8 0 0 0 457987 1 1 20.846 LOW 1 0 0 0 1 17 1 8 0 0 0 397.863 460.715 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883770 14235.2 14235.9 3 F 9 9 56366 1 0 39.6519 LOW 1 0 0 0 1 49 1 8 0 0 0 327868 1 1 31.4617 MEDIUM 2 0 0 0 2 27 2 8 0 0 0 37.3863 249.046 10000 10000 3 2 0 0 UNKNOWN UNKNOWN
883785 14235.2 14256.4 3 F 9 9 268446 0 0 35.5965 MEDIUM 2 0 0 0 2 23 2 8 0 0 0 327868 1 1 31.4617 MEDIUM 7 0 0 0 7 32 7 8 0 0 0 540.55 249.046 -1 10000 0 2 0 0 UNKNOWN UNKNOWN
883786 14235.2 14239.3 3 F 9 9 386619 1 0 26.9615 LOW 1 0 0 0 1 19 6 8 0 0 0 404054 1 1 25.4614 MEDIUM 4 0 0 0 4 17 4 8 0 0 0 436.587 100.519 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883807 14235.2 14236.1 3 F 8 8 258282 1 0 36.3081 LOW 1 0 0 0 1 60 1 8 0 0 0 269612 0 1 35.5196 LOW 1 0 0 0 1 36 1 8 0 0 0 245.487 540.55 10000 -1 2 0 0 0 UNKNOWN UNKNOWN
883820 14235.2 14242.5 3 F 7 7 228857 1 0 38.3658 LOW 2 0 0 0 2 29 5 8 0 0 0 387565 1 1 26.9038 LOW 1 0 0 0 1 19 7 8 0 0 0 394.527 91.2097 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883823 14235.2 14246.8 3 F 7 7 361066 0 0 29 LOW 3 0 0 0 3 31 6 8 0 0 0 328341 1 1 31.4232 LOW 2 0 0 0 2 17 3 8 0 0 0 540.55 113.142 -1 10000 0 2 0 0 UNKNOWN UNKNOWN
883824 14235.2 14237.7 3 F 7 7 450408 0 0 21.4998 MEDIUM 1 0 0 0 1 6 5 8 0 0 0 321950 0 1 31.904 MEDIUM 4 0 0 0 4 30 7 8 0 0 0 540.55 540.55 -1 -1 0 0 0 0 UNKNOWN UNKNOWN
883854 14235.2 14246.3 3 F 6 6 457580 0 0 20.8844 LOW 3 0 0 0 3 5 4 8 0 0 0 505386 0 1 17.1153 LOW 7 0 0 0 7 9 9 8 0 0 0 540.55 540.55 -1 -1 0 0 0 0 UNKNOWN UNKNOWN
883855 14235.2 14237.7 3 F 6 6 388797 1 0 26.7884 MEDIUM 1 0 0 0 1 15 2 8 0 0 0 503714 0 1 17.2499 MEDIUM 3 0 0 0 3 9 8 8 0 0 0 210.912 540.55 10000 -1 2 0 0 0 UNKNOWN UNKNOWN
883856 14235.2 14242.4 3 F 6 6 388797 1 0 26.7884 MEDIUM 2 0 0 0 2 16 3 8 0 0 0 115436 1 1 39.6725 LOW 7 0 0 0 7 79 10 8 0 0 0 210.912 45.0356 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883880 14235.2 14236.9 3 F 5 5 479723 1 0 19.1152 LOW 5 0 0 0 5 8 7 8 0 0 0 128251 0 1 59.1656 LOW 4 0 0 0 4 57 11 8 0 0 0 496.747 540.55 10000 -1 2 0 0 0 UNKNOWN UNKNOWN
883903 14235.2 14259 3 F 4 4 341794 1 0 30.4232 LOW 4 0 0 0 4 27 9 8 0 0 0 528563 0 1 15.5192 LOW 7 0 0 0 7 18 18 8 0 0 0 172.558 540.55 10000 -1 2 0 0 0 UNKNOWN UNKNOWN
883912 14235.2 14239.1 3 F 4 4 234951 1 0 37.9235 LOW 4 0 0 0 4 31 6 8 0 0 0 523976 1 1 15.8269 MEDIUM 6 0 0 0 6 11 10 8 0 0 0 275.11 481.14 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883913 14235.2 14247.9 3 F 4 4 325272 1 0 31.6348 HIGH 1 0 0 0 1 637 14 8 0 0 0 523976 1 1 15.8269 MEDIUM 7 0 0 0 7 12 11 8 0 0 0 207.152 481.14 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883914 14235.2 14235.3 3 F 4 4 325272 1 0 31.6348 HIGH 2 0 0 0 2 638 15 8 0 0 0 215866 1 1 40.053 LOW 5 0 0 0 5 41 8 8 0 0 0 207.152 116.016 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883915 14235.2 14243.1 3 F 4 4 325272 1 0 31.6348 HIGH 3 0 0 0 3 639 16 8 0 0 0 363970 0 1 28.7885 LOW 8 0 0 0 8 35 13 8 0 0 0 207.152 540.55 10000 -1 2 0 0 0 UNKNOWN UNKNOWN
883916 14235.2 14242 3 F 4 4 346843 1 0 30.0578 MEDIUM 3 0 0 0 3 35 6 8 0 0 0 459978 1 1 20.7114 LOW 5 0 0 0 5 10 7 8 0 0 0 228.651 358.639 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883925 14235.2 14237 3 F 3 3 464763 0 0 20.3267 MEDIUM 3 0 0 0 3 3 3 8 0 0 0 487005 1 1 18.5383 LOW 6 0 0 0 6 10 9 8 0 0 0 540.55 473.809 -1 10000 0 2 0 0 UNKNOWN UNKNOWN
883949 14235.2 14248.4 3 F 2 2 377709 1 0 27.7115 LOW 5 0 0 0 5 24 7 8 0 0 0 290930 1 1 34.0964 LOW 3 0 0 0 3 26 7 8 0 0 0 76.2245 124.732 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883950 14235.2 14242.8 3 F 2 2 404758 0 0 25.4037 MEDIUM 1 0 0 0 1 22 3 8 0 0 0 356545 1 1 29.3462 LOW 4 0 0 0 4 40 6 8 0 0 0 540.55 98.4628 -1 10000 0 2 0 0 UNKNOWN UNKNOWN
883967 14235.2 14968.7 0 F 1 1 423183 0 0 23.846 MEDIUM 2 2 0 0 0 19 2 9 0 0 0 410797 1 1 24.9037 MEDIUM 3 3 0 0 0 21 2 9 0 0 0 540.55 43.1436 -1 10000 0 3 0 0 UNKNOWN UNKNOWN
883968 14235.2 14588.2 0 F 1 1 499985 1 0 17.4999 LOW 1 1 0 0 0 4 1 9 0 0 0 473508 1 1 19.6345 LOW 1 1 0 0 0 7 1 8 0 0 0 286.463 429.439 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
883969 14235.2 14691.2 0 F 1 1 398895 1 0 25.9038 MEDIUM 2 2 0 0 0 17 2 15 0 0 0 432555 1 1 23.0575 MEDIUM 2 2 0 0 0 14 1 15 0 0 0 90.2584 269.551 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
884026 14235.2 14359.3 0 F 1 1 366412 1 0 28.6154 HIGH 4 1 1 1 1 515 16 15 0 0 0 425812 1 1 23.6152 MEDIUM 3 3 0 0 0 19 2 9 0 0 0 177.698 47.4143 10000 10000 2 3 0 0 UNKNOWN UNKNOWN
884027 14235.2 14378.2 0 F 1 1 375168 0 0 27.9423 LOW 1 1 0 0 0 11 2 9 0 0 0 424129 1 1 23.7691 MEDIUM 3 3 0 0 0 45 2 9 0 0 0 540.55 293.234 -1 10000 0 2 0 0 UNKNOWN UNKNOWN
884028 14235.2 14511.9 0 F 1 1 50041 1 0 45.0963 LOW 2 2 0 0 0 53 2 9 0 0 0 38447 0 1 51.9062 MEDIUM 1 1 0 0 0 14 1 8 0 0 0 53.1819 540.55 10000 -1 2 0 0 0 UNKNOWN UNKNOWN
884038 14235.2 14290.7 1 F 1 1 328891 1 0 31.3848 LOW 1 0 1 0 0 8 1 8 0 0 0 326625 1 1 31.5386 MEDIUM 2 1 1 0 0 18 2 15 0 0 0 411.015 67.7839 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
884039 14235.2 14850.4 1 F 1 1 45201 1 0 58.6934 LOW 1 0 1 0 0 42 1 9 0 0 0 95691 0 1 58.8829 LOW 1 0 1 0 0 30 1 8 0 0 0 111.626 540.55 10000 -1 2 0 0 0 UNKNOWN UNKNOWN
884040 14235.2 14239.3 3 F 1 1 408641 1 0 25.0768 HIGH 3 1 0 1 1 316 18 15 0 0 0 352684 1 1 29.6155 HIGH 2 1 0 0 1 593 24 15 0 0 0 329.253 209.064 10000 10000 2 2 0 0 UNKNOWN UNKNOWN
884041 14235.2 14246.9 3 F 1 1 440926 1 0 22.3075 HIGH 3 1 0 1 1 305 21 15 0 0 0 496971 1 1 17.7499 HIGH 3 1 1 0 1 32 15 15 0 0 0 52.7971 51.8892 10000 10000 3 2 0 0 UNKNOWN UNKNOWN
884042 14235.2 14236 3 F 1 1 511799 0 0 16.6538 HIGH 1 0 0 0 1 23 19 15 0 0 0 508411 1 1 16.8845 HIGH 4 0 1 1 2 75 27 15 0 0 0 540.55 47.8489 -1 10000 0 2 0 0 UNKNOWN UNKNOWN