ReportRelationshipCensus#

The relationship census report (ReportRelationshipCensus.csv) is a CSV-formatted report that extracts relationship numbers for each person during each taking of the census. The census is a one day event collecting data for that person as of that day.

Configuration#

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

Parameter

Data type

Min

Max

Default

Description

Report_File_Name

string

NA

NA

ReportRelationshipCensus.csv

Use this parameter to designate a custom file name, if desired.

Start_Year

float

0

FLT_MAX

0

Simulation time in years to start collecting data.

End_Year

float

0

FLT_MAX

FLT_MAX

Simulation time in years to stop collecting data.

Reporting_Interval_Years

float

0

100

1

Years between census-taking.

{
    "Reports": [
        {
            "class": "ReportRelationshipCensus",
            "Report_File_Name": "MyCensusReport.csv",
            "Start_Year": 2020,
            "End_Year": 2050,
            "Reporting_Interval_Years": 1
        }
    ],
    "Use_Defaults": 1
}

Output file data#

The output report will contain the following information.

Data columns#

Parameter

Data type

Description

Year

float

Current time of the census in years.

NodeID

integer

The External ID of the node that the data is being collected for.

IndividualID

integer

The unique ID of the person whose information is being collected.

Gender

string

The gender of the individual. Possible values are “M” or “F.”

AgeYears

float

The age in years of the person whose information is being collected.

IndividualProperties

string

A single string with the person’s properties. The string will have a format where a key and value are separated by colons and the key-value pairs are separated by semi-colons. For example: KeyA:ValueA1;KeyB:ValueB1;KeyC:ValueC1.

NumRels_Last6Months_TRANSITORY

integer

The number of transitory relationships that the person has started in the last 6 months.

NumRels_Last6Months_INFORMAL

integer

The number of informal relationships that the person has started in the last 6 months.

NumRels_Last6Months_MARITAL

integer

The number of marital relationships that the person has started in the last 6 months.

NumRels_Last6Months_COMMERCIAL

integer

The number of commercial relationships that the person has started in the last 6 months.

NumRels_Active_TRANSITORY

integer

The number of transitory relationships the person has on the day of the census.

NumRels_Active_INFORMAL

integer

The number of active informal relationships the person has on the day of the census.

NumRels_Active_MARITAL

integer

The number of active marital relationships the person has on the day of the census.

NumRels_Active_COMMERCIAL

integer

The number of active commercial relationships the person has on the day of the census.

NumRels_Last12Months_TRANSITORY

integer

The number of transitory relationships that the person has started in the last 12 months.

NumRels_Last12Months_INFORMAL

integer

The number of informal relationships that the person has started in the last 12 months.

NumRels_Last12Months_MARITAL

integer

The number of marital relationships that the person has started in the last 12 months.

NumRels_Last12Months_COMMERCIAL

integer

The number of commercial relationships that the person has started in the last 12 months.

NumUniquePartners_Last-3-Months_TRANSITORY

integer

The number of different people that this person has had a transitory relationship in the last 3 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-3-Months_INFORMAL

integer

The number of different people that this person has had a informal relationship in the last 3 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-3-Months_MARITAL

integer

The number of different people that this person has had a marital relationship in the last 3 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-3-Months_COMMERCIAL

integer

The number of different people that this person has had a commercial relationship in the last 3 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-6-Months_TRANSITORY

integer

The number of different people that this person has had a transitory relationship in the last 6 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-6-Months_INFORMAL

integer

The number of different people that this person has had a informal relationship in the last 6 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-6-Months_MARITAL

integer

The number of different people that this person has had a marital relationship in the last 6 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-6-Months_COMMERCIAL

integer

The number of different people that this person has had a commercial relationship in the last 6 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-9-Months_TRANSITORY

integer

The number of different people that this person has had a transitory relationship in the last 9 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-9-Months_INFORMAL

integer

The number of different people that this person has had a informal relationship in the last 9 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-9-Months_MARITAL

integer

The number of different people that this person has had a marital relationship in the last 9 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-9-Months_COMMERCIAL

integer

The number of different people that this person has had a commercial relationship in the last 9 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-12-Months_TRANSITORY

integer

The number of different people that this person has had a transitory relationship in the last 12 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-12-Months_INFORMAL

integer

The number of different people that this person has had a informal relationship in the last 12 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-12-Months_MARITAL

integer

The number of different people that this person has had a marital relationship in the last 12 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

NumUniquePartners_Last-12-Months_COMMERCIAL

integer

The number of different people that this person has had a commercial relationship in the last 12 months. This is different than just the number of relationships because one could start and stop relationships with the same person.

Example#

The following is an example of a ReportRelationshipCensus.csv file.

Year

NodeID

IndividualID

Gender

AgeYears

IndividualProperties

NumRels_Last6Months_TRANSITORY

NumRels_Last6Months_INFORMAL

NumRels_Last6Months_MARITAL

NumRels_Last6Months_COMMERCIAL

NumRels_Active_TRANSITORY

NumRels_Active_INFORMAL

NumRels_Active_MARITAL

NumRels_Active_COMMERCIAL

NumRels_Last12Months_TRANSITORY

NumRels_Last12Months_INFORMAL

NumRels_Last12Months_MARITAL

NumRels_Last12Months_COMMERCIAL

NumUniquePartners_Last-3-Months_TRANSITORY

NumUniquePartners_Last-3-Months_INFORMAL

NumUniquePartners_Last-3-Months_MARITAL

NumUniquePartners_Last-3-Months_COMMERCIAL

NumUniquePartners_Last-6-Months_TRANSITORY

NumUniquePartners_Last-6-Months_INFORMAL

NumUniquePartners_Last-6-Months_MARITAL

NumUniquePartners_Last-6-Months_COMMERCIAL

NumUniquePartners_Last-9-Months_TRANSITORY

NumUniquePartners_Last-9-Months_INFORMAL

NumUniquePartners_Last-9-Months_MARITAL

NumUniquePartners_Last-9-Months_COMMERCIAL

NumUniquePartners_Last-12-Months_TRANSITORY

NumUniquePartners_Last-12-Months_INFORMAL

NumUniquePartners_Last-12-Months_MARITAL

NumUniquePartners_Last-12-Months_COMMERCIAL

1962

1

2

F

12.0359

Risk:LOW

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

1962

1

3

F

20.6407

Risk:LOW

0

0

7

0

0

0

0

0

0

0

9

0

0

0

1

0

0

0

7

0

0

0

9

0

0

0

9

0

1962

1

4

F

62.176

Risk:LOW

0

0

14

0

0

0

0

0

0

0

28

0

0

0

7

0

0

0

13

0

0

0

19

0

0

0

23

0

1962

1

5

F

47.2766

Risk:LOW

0

0

31

0

0

0

0

0

0

0

52

0

0

0

18

0

0

0

29

0

0

0

35

0

0

0

43

0

1962

1

6

F

54.0897

Risk:LOW

0

0

13

0

0

0

0

0

0

0

30

0

0

0

5

0

0

0

11

0

0

0

20

0

0

0

21

0

1962

1

7

M

14.3385

Risk:LOW

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

1962

1

8

F

8.85676

Risk:LOW

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

1962

1

9

M

5.39688

Risk:LOW

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

1962

1

10

M

24.2559

Risk:LOW

0

0

4

0

0

0

0

0

0

0

12

0

0

0

1

0

0

0

4

0

0

0

8

0

0

0

12

0

1963

1

2

F

13.0359

Risk:LOW

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

1963

1

3

F

21.6407

Risk:LOW

0

0

8

0

0

0

0

0

0

0

12

0

0

0

4

0

0

0

8

0

0

0

8

0

0

0

12

0

1963

1

4

F

63.176

Risk:LOW

0

0

2

0

0

0

0

0

0

0

15

0

0

0

0

0

0

0

2

0

0

0

6

0

0

0

15

0

1963

1

5

F

48.2766

Risk:LOW

0

0

18

0

0

0

0

0

0

0

46

0

0

0

7

0

0

0

14

0

0

0

24

0

0

0

35

0

1963

1

6

F

55.0897

Risk:LOW

0

0

16

0

0

0

1

0

0

0

37

0

0

0

10

0

0

0

17

0

0

0

24

0

0

0

29

0

1963

1

7

M

15.3385

Risk:LOW

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

1963

1

8

F

9.85676

Risk:LOW

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

1963

1

9

M

6.39688

Risk:LOW

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

1963

1

10

M

25.2559

Risk:LOW

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

1

0

1964

1

2

F

14.0359

Risk:LOW

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

1964

1

3

F

22.6407

Risk:LOW

0

0

11

0

0

0

0

0

0

0

18

0

0

0

8

0

0

0

12

0

0

0

16

0

0

0

17

0

1964

1

4

F

64.176

Risk:LOW

0

0

3

0

0

0

0

0

0

0

5

0

0

0

1

0

0

0

3

0

0

0

3

0

0

0

4

0

1964

1

5

F

49.2766

Risk:LOW

0

0

14

0

0

0

1

0

0

0

37

0

0

0

8

0

0

0

15

0

0

0

25

0

0

0

29

0

1964

1

6

F

56.0897

Risk:LOW

0

0

14

0

0

0

0

0

0

0

22

0

0

0

10

0

0

0

15

0

0

0

17

0

0

0

18

0

1964

1

7

M

16.3385

Risk:LOW

0

0

2

0

0

0

1

0

0

0

2

0

0

0

2

0

0

0

2

0

0

0

2

0

0

0

2

0

1964

1

8

F

10.8568

Risk:LOW

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

1964

1

9

M

7.39688

Risk:LOW

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

1964

1

10

M

26.2559

Risk:LOW

0

0

3

0

0

0

0

0

0

0

8

0

0

0

1

0

0

0

3

0

0

0

6

0

0

0

8

0