Coital act report¶
The coital act report is a CSV-formatted output file which provides detailed information about each coital act. It includes time, relationship and participant IDs, whether a condom was used, and each participant’s age, gender, infection status, circumcision status, co-infection status, and treatment status. The filename is RelationshipConsummated.csv.
To generate the report, set the configuration parameter Report_Coital_Acts to 1.
Report structure and data channel descriptions¶
The file contains the following data channels:
Data channel |
Data type |
Description |
|---|---|---|
Time |
integer |
The time in days during the simulation that the infection was transmitted. |
Node_ID |
integer |
The identifying number of the node. |
Rel_ID |
integer |
A unique identifier for the relationship (different from the participant IDs). |
<A or B>_ID |
integer |
The unique identifier for each individual in the relationship. This column will be 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>_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. |
Did_Use_Condom |
boolean |
Describes if a condom was used for the coital act; 0 for no condom used, 1 for a condom was used. |
<A or B>_Num_Current_Rels |
integer |
The total number of active relationships in which the individual is currently participating. This column is repeated for each individual in the relationship. |
<A or B>_Is_Circumcised |
boolean |
Indicates whether or not the individual is circumcised; 0 for not circumcised, 1 for circumcised (only relevant for males). This column is repeated for each individual in the relationship. |
<A or B>_has_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 and will only be displayed for HIV simulations. |
<A or B>_HIV_Infection_Stage |
enum |
The stage of infection for the receiving individual. 0 for uninfected, 1 for untreated acute HIV, 2 for untreated latent HIV, 3 for untreated late/AIDS stage, 4 for on ART, -1 implies the receiving individual does not have HIV. This column is repeated for each individual in the relationship and will only be displayed for HIV simulations. |
<A or B>_Is_On_ART |
boolean |
Indicates whether or not the individual is on ART; 0 if they are not on ART, 1 if they are currently receiving ART. This column is repeated for each individual in the relationship and will only be displayed for HIV simulations. |
Example¶
The following is an example of a RelationshipConsummated.csv report:
Time |
Node_ID |
Rel_ID |
A_ID |
B_ID |
A_Gender |
B_Gender |
A_Age |
B_Age |
A_Is_Infected |
B_Is_Infected |
Did_Use_Condom |
A_Num_Current_Rels |
B_Num_Current_Rels |
A_Is_Circumcised |
B_Is_Circumcised |
A_Has_CoInfection |
B_Has_CoInfection |
A_HIV_Infection_Stage |
B_HIV_Infection_Stage |
A_Is_On_ART |
B_Is_On_ART |
6 |
1 |
8 |
1 |
19 |
MALE |
FEMALE |
31.8508 |
5.89885 |
0 |
0 |
0 |
3 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
6 |
1 |
9 |
1 |
20 |
MALE |
FEMALE |
31.8508 |
11.6313 |
0 |
0 |
0 |
3 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
6 |
1 |
10 |
1 |
9 |
MALE |
FEMALE |
31.8508 |
1.07552 |
0 |
0 |
0 |
3 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
6 |
1 |
1 |
4 |
10 |
MALE |
FEMALE |
23.3918 |
24.4321 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
6 |
1 |
2 |
5 |
11 |
MALE |
FEMALE |
38.1434 |
21.831 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
6 |
1 |
3 |
6 |
12 |
MALE |
FEMALE |
48.3907 |
52.1181 |
0 |
0 |
0 |
3 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
6 |
1 |
4 |
6 |
13 |
MALE |
FEMALE |
48.3907 |
42.5697 |
0 |
0 |
0 |
3 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
6 |
1 |
6 |
6 |
17 |
MALE |
FEMALE |
48.3907 |
16.5837 |
0 |
0 |
0 |
3 |
3 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
6 |
1 |
5 |
7 |
17 |
MALE |
FEMALE |
25.9589 |
16.5837 |
0 |
0 |
0 |
1 |
3 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
6 |
1 |
7 |
18 |
17 |
MALE |
FEMALE |
52.0453 |
16.5837 |
0 |
0 |
0 |
1 |
3 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
7 |
1 |
10 |
1 |
9 |
MALE |
FEMALE |
31.8536 |
1.07826 |
0 |
0 |
0 |
3 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
8 |
1 |
1 |
4 |
10 |
MALE |
FEMALE |
23.3972 |
24.4376 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
8 |
1 |
5 |
7 |
17 |
MALE |
FEMALE |
25.9644 |
16.5892 |
0 |
0 |
0 |
1 |
3 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
8 |
1 |
7 |
18 |
17 |
MALE |
FEMALE |
52.0508 |
16.5892 |
0 |
0 |
0 |
1 |
3 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
10 |
1 |
1 |
4 |
10 |
MALE |
FEMALE |
23.4027 |
24.443 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
11 |
1 |
1 |
4 |
10 |
MALE |
FEMALE |
23.4055 |
24.4458 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
11 |
1 |
1 |
4 |
10 |
MALE |
FEMALE |
23.4055 |
24.4458 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
11 |
1 |
2 |
5 |
11 |
MALE |
FEMALE |
38.1571 |
21.8447 |
0 |
0 |
0 |
1 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
11 |
1 |
3 |
6 |
12 |
MALE |
FEMALE |
48.4044 |
52.1318 |
0 |
0 |
0 |
3 |
1 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |
11 |
1 |
5 |
7 |
17 |
MALE |
FEMALE |
25.9726 |
16.5974 |
0 |
0 |
0 |
1 |
3 |
0 |
0 |
0 |
0 |
-1 |
-1 |
0 |
0 |