How to upload a virtual population?

updated 9 mths ago

You can upload your population in jinkō with two different formats (JSON and CSV). This can be done using the create VPOP feature

Requirements

In both cases (JSON and CSV), you need the following information per patient:

A patientIndex: Text - a unique value identifying the patient
A set of patientAttributes where each attribute has:
- An identifier
- A value
- An optional unit

This translates as follows for each format:

CSV format

The separator is the standard comma: “,”

The header follows the pattern patientIndex,id₁(unit₁), id₂, ..., id_n(unit_n) . The unit can be specified in brackets (unit) after the id. In this example id₂ does not have a unit specified

Body follows the following pattern: patient₁, val¹₁, val¹₂, ..., val¹_n

patientIndex column: Text, should be unique for each row
Patient descriptors columns: Float is mandatory

Example (presented in tabular format for readability):

patientIndex	age(year)	sizeHelper	isMale
patient1	60.7	0.294	1
patient2	55.2	0.407	0
patient3	70.3	0.822	0

JSON format

The virtual population object is a list of patients

Each Patient has:

A "patientIndex": Text
A "patientAttributes": Object
- "id": Text
- "val": Float
- "unit": Text (optional)

Example:

{
    "patients": [{
            "patientIndex": "patient1",
            "patientAttributes": [{
                    "id": "age",
                    "val": 60.7,
                    "unit": "year"
                },
                {
                    "id": "sizeHelper",
                    "val": 0.294,
                    "unit": "dimensionless"
                },
                {
                    "id": "isMale",
                    "val": 1,
                    "unit": "dimensionless"
                }
            ],
            "patientIndex": "patient1"
        },
        {
            "patientIndex": "patient2",
            "patientAttributes": [{
                    "id": "age",
                    "val": 55.2,
                    "unit": "year"
                },
                {
                    "id": "sizeHelper",
                    "val": 0.407,
                    "unit": "dimensionless"
                },
                {
                    "id": "isMale",
                    "val": 0,
                    "unit": "dimensionless"
                }
            ]

        },
        {
            "patientIndex": "patient3",
            "patientAttributes": [{
                    "id": "age",
                    "val": 70.3,
                    "unit": "year"
                },
                {
                    "id": "sizeHelper",
                    "val": 0.822,
                    "unit": "dimensionless"
                },
                {
                    "id": "isMale",
                    "val": 0,
                    "unit": "dimensionless"
                }
            ]

        }
    ]
}

A note on Units

The unit should be in the same dimension as the unit used for this descriptor in the computational model. If it is the same dimension but a different unit ( cm to m for example), the value will be converted.

More information on units can be found on the dedicated page, in particular on the semantics and on the exhaustive list of available units and prefixes.