Relationship formation report¶
The relationship formation report is a CSV-formatted output file which 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, and number of active, recent, lifetime relationships, and individual properties). Each participant in a relationship is referred to as either participant “A” or participant “B”. The filename is RelationshipStart.csv.
To generate the report, set the configuration parameter Report_Relationship_Start to 1.
Report structure and data channel descriptions¶
The file contains the following data channels:
Data channel |
Data type |
Description |
||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Rel_ID |
integer |
A unique identifier for the relationship, different from the IDs of the participants. |
||||||||||||||||||||||||
Rel_start_time |
integer |
The time (in days) during the simulation when the relationship started. |
||||||||||||||||||||||||
Rel_scheduled_end_time |
integer |
The time (in days) during the simulation that the relationship was scheduled to end. This is determined when the relationship is created based on the relationship type and its Weibull distribution parameters. |
||||||||||||||||||||||||
Rel_type (0 = TRANSITORY; 1 = INFORMAL; 2 = MARITAL; 3 = COMMERCIAL) |
integer |
The types of relationship between individuals A and B; 0 is transitory, 1 is informal, 2 is marital, and 3 is commercial. |
||||||||||||||||||||||||
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 |
string |
This column is the unique numerical identifier for the individual, and is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_is_infected |
boolean |
Describes whether or not the individual is infected: 0 for not infected, 1 for infected. The column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_gender |
boolean |
The gender of the individual; 0 is for male, 1 is for female. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_Age |
float |
The age of the individual in units of years. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_total_num_active_rels |
integer |
The total number of active relationships the individual is currently in. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_total_num_TRANSITORY_rels |
integer |
The total number of transitory relationships the individual is currently in. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_total_num_INFORMAL_rels |
integer |
The total number of informal relationships the individual is currently in. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_total_num_MARITAL_rels |
integer |
The total number of marital relationships the individual is currently in. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_total_num_COMMERCIAL_rels |
integer |
The total number of commercial relationships the individual is currently in. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_num_lifetime_rels |
integer |
The total number of relationships the individual has had during their lifetime. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_num__rels_last_6_mo |
integer |
The total number of relationships the individual has had in the last 6 months. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_extra_relational_bitmask |
enum |
Indicates which types of relationships that individual is allowed to have when they have more than one active relationship. These are encoded in a 3-digit bitmask. In order, the digits correspond to commercial, marital, informal, and transitory relationships. The following table lists some of the possible combinations:
|
||||||||||||||||||||||||
<A or B>_is_circumcised |
boolean |
Indicates whether or not the individual is circumcised; 0 for not circumcised, 1 for circumcised. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<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. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_is_super-spreader |
boolean |
Indicates whether or not the individual is a super-spreader; 0 for when they are not a super-spreader, 1 for when they are a super-spreader. Determination of whether or not an individual is a super-spreader is determined by the demographics parameter Probability_Person_Is_Behavioral_Super_Spreader. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_Individual_Properties |
string |
The IndividualProperties associated with each partner. This string may contain multiple key-value pairs. Each key and value are separated by a hyphen, and each pair is separated by a semicolon. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_CD4_count |
float |
The CD4 count for each partner; only included in HIV simulations. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_viral_load |
float |
This is not currently supported. -1 implies that the partner is not infected, 1000 implies that the partner is infected; only included in HIV simulations. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_HIV_disease_stage |
float |
The stage of infection for each individual; only included in HIV simulations. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_HIV_Tested_Positive |
boolean |
Whether or not the partner has ever tested positive for HIV using the results of HIVRapidHIVDiagnostic. 0 indicates the partner never tested positive, 1 indicates they have tested positive; only included in HIV simulations. This column is repeated for each individual in the relationship. |
||||||||||||||||||||||||
<A or B>_HIV_Received_Results |
string |
Represents the results received by the individual from the latest HIV test using HIVRapidHIVDiagnostic. UNKNOWN implies that the individual did not receive their results. NEGATIVE implies that the most recent results were negative. POSITIVE implies that the most recent results were positive. Whether or not the an individual receives their results is determined by the campaign parameter Probability_Received_Results. This column is only included in HIV simulations, and is repeated for each individual in the relationship. |
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) |
Original_node_ID |
Current_node_ID |
A_ID |
A_is_infected |
A_gender |
A_age |
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_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_IndividualProperties |
B_IndividualProperties |
1 |
0 |
143.826 |
0 |
1 |
1 |
6 |
0 |
0 |
54.7556 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
41 |
0 |
1 |
54.3819 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
2 |
0 |
230.965 |
0 |
1 |
1 |
13 |
0 |
0 |
50.4217 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
96 |
0 |
1 |
53.6578 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
3 |
0 |
661.788 |
0 |
1 |
1 |
17 |
0 |
0 |
16.7325 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
16 |
0 |
1 |
31.8341 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
4 |
0 |
363.042 |
0 |
1 |
1 |
24 |
0 |
0 |
25.1341 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
28 |
0 |
1 |
24.2832 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
5 |
0 |
312.26 |
0 |
1 |
1 |
33 |
0 |
0 |
40.6728 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
160 |
0 |
1 |
51.2454 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
6 |
0 |
575.485 |
0 |
1 |
1 |
34 |
0 |
0 |
46.7212 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
207 |
0 |
1 |
46.8979 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
7 |
0 |
623.067 |
0 |
1 |
1 |
37 |
0 |
0 |
28.0571 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
43 |
0 |
1 |
19.6776 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
8 |
0 |
212.94 |
0 |
1 |
1 |
89 |
0 |
0 |
51.183 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
264 |
0 |
1 |
52.8355 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
9 |
0 |
269.793 |
0 |
1 |
1 |
119 |
0 |
0 |
20.9176 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
69 |
0 |
1 |
34.3996 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
10 |
0 |
264.251 |
0 |
1 |
1 |
124 |
0 |
0 |
51.8397 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
269 |
0 |
1 |
53.4856 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
11 |
0 |
443.981 |
0 |
1 |
1 |
126 |
0 |
0 |
21.1711 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
83 |
0 |
1 |
35.8609 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
12 |
0 |
304.286 |
0 |
1 |
1 |
127 |
0 |
0 |
46.7705 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
102 |
0 |
1 |
27.4345 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
13 |
0 |
78.137 |
0 |
1 |
1 |
136 |
0 |
0 |
32.0056 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
112 |
0 |
1 |
37.1143 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
14 |
0 |
144.309 |
0 |
1 |
1 |
169 |
0 |
0 |
49.586 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
279 |
0 |
1 |
54.5846 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
15 |
0 |
157.548 |
0 |
1 |
1 |
174 |
0 |
0 |
20.1425 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
118 |
0 |
1 |
31.9763 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
16 |
0 |
141.926 |
0 |
1 |
1 |
182 |
0 |
0 |
50.0208 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
340 |
0 |
1 |
52.496 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
17 |
0 |
171.394 |
0 |
1 |
1 |
183 |
0 |
0 |
44.1562 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
347 |
0 |
1 |
46.8906 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
18 |
0 |
3.59115 |
0 |
1 |
1 |
211 |
0 |
0 |
35.0802 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
120 |
0 |
1 |
33.093 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
19 |
0 |
189.097 |
0 |
1 |
1 |
216 |
0 |
0 |
24.3044 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
140 |
0 |
1 |
18.0885 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |
20 |
0 |
409.715 |
0 |
1 |
1 |
217 |
0 |
0 |
23.0034 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
141 |
0 |
1 |
17.2887 |
1 |
1 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
None |
None |