Virtual populations

Method	Description
list_vpops	List vpops.
iter_vpops	Iterate over vpops.
get_vpop	Get a vpop by SID.
create_vpop_from_csv	Create a virtual population from CSV content.
create_vpop_from_patients_list	Create a virtual population from a list of patient parameter dicts.
create_vpop_from_dataframe	Create a virtual population from a pandas DataFrame.
list_vpop_designs	List vpop generators.
iter_vpop_designs	Iterate over vpop generators.
get_vpop_design	Get a vpop generator by SID.
create_vpop_design_from_json	Create a vpop generator from a raw JSON payload.
create_vpop_design_from_design	Create a vpop generator from a statistical design.

list_vpops

list_vpops(
    *,
    name: str | None = None,
    folder: Folder | str | None = None,
    limit: int | None = None,
    deleted: bool = False,
    after: str | None = None
) -> Page[Vpop]

List vpops.

Parameters:

Name	Type	Description	Default
name	str | None	Optional name filter.	None
folder	Folder | str | None	Optional folder filter.	None
limit	int | None	Maximum number of results to return.	None
deleted	bool	Whether to include deleted vpops.	False
after	str | None	Pagination cursor.	None

Returns:

• Page[Vpop]: A page of Vpop objects.

iter_vpops

iter_vpops(
    *,
    name: str | None = None,
    folder: Folder | str | None = None,
    deleted: bool = False
) -> Iterator[Vpop]

Iterate over vpops.

Parameters:

Name	Type	Description	Default
name	str | None	Optional name filter.	None
folder	Folder | str | None	Optional folder filter.	None
deleted	bool	Whether to include deleted vpops.	False

Yields:

• Vpop: Vpop objects.

get_vpop

get_vpop(
    sid: str, *, revision: int | None = None, allow_deleted: bool = False
) -> Vpop

Get a vpop by SID.

Parameters:

Name	Type	Description	Default
sid	str	The SID of the vpop.
revision	int | None	Optional revision number.	None
allow_deleted	bool	Whether to allow retrieving deleted vpops.	False

Returns:

• Vpop: The requested Vpop.

create_vpop_from_csv

create_vpop_from_csv(
    *,
    csv_content: str | bytes | None = None,
    csv_file_path: str | Path | None = None,
    name: str | None = None,
    description: str | None = None,
    version: str | dict | None = None,
    folder: Folder | str | None = None
) -> Vpop

Create a virtual population from CSV content.

Exactly one of csv_content or csv_file_path must be provided. Each row in the CSV represents one patient, and each column represents a parameter.

Parameters:

Name	Type	Description	Default
csv_content	str | bytes | None	The CSV data as a string or bytes.	None
csv_file_path	str | Path | None	Path to a CSV file.	None
name	str | None	Optional name for the new project item.	None
description	str | None	Optional description for the new project item.	None
version	str | dict | None	Optional version name str. Can also be a dict with the keys name and description to set a version description.	None
folder	Folder | str | None	Optional destination folder.	None

Returns:

• Vpop: The created Vpop.

create_vpop_from_patients_list

create_vpop_from_patients_list(
    patients: list[dict],
    *,
    name: str | None = None,
    description: str | None = None,
    version: str | dict | None = None,
    folder: Folder | str | None = None
) -> Vpop

Create a virtual population from a list of patient parameter dicts.

Each entry in patients is a dict mapping parameter ids to their values for that patient.

Parameters:

Name	Type	Description	Default
patients	list[dict]	List of patient parameter mappings.
name	str | None	Optional name for the new project item.	None
description	str | None	Optional description for the new project item.	None
version	str | dict | None	Optional version name str. Can also be a dict with the keys name and description to set a version description.	None
folder	Folder | str | None	Optional destination folder.	None

Returns:

• Vpop: The created Vpop.

create_vpop_from_dataframe

create_vpop_from_dataframe(
    df: Any,
    *,
    name: str | None = None,
    description: str | None = None,
    version: str | dict | None = None,
    folder: Folder | str | None = None
) -> Vpop

Create a virtual population from a pandas DataFrame.

Each row in the DataFrame represents one patient, and each column represents a parameter.

Parameters:

Name	Type	Description	Default
df	Any	A pandas DataFrame whose rows represent the patient population.
name	str | None	Optional name for the new project item.	None
description	str | None	Optional description for the new project item.	None
version	str | dict | None	Optional version name str. Can also be a dict with the keys name and description to set a version description.	None
folder	Folder | str | None	Optional destination folder.	None

Returns:

• Vpop: The created Vpop.

list_vpop_designs

list_vpop_designs(
    *,
    name: str | None = None,
    folder: Folder | str | None = None,
    limit: int | None = None,
    deleted: bool = False,
    after: str | None = None
) -> Page[VpopDesign]

List vpop generators.

Parameters:

Name	Type	Description	Default
name	str | None	Optional name filter.	None
folder	Folder | str | None	Optional folder filter.	None
limit	int | None	Maximum number of results to return.	None
deleted	bool	Whether to include deleted vpop generators.	False
after	str | None	Pagination cursor.	None

Returns:

• Page[VpopDesign]: A page of VpopDesign objects.

iter_vpop_designs

iter_vpop_designs(
    *,
    name: str | None = None,
    folder: Folder | str | None = None,
    deleted: bool = False
) -> Iterator[VpopDesign]

Iterate over vpop generators.

Parameters:

Name	Type	Description	Default
name	str | None	Optional name filter.	None
folder	Folder | str | None	Optional folder filter.	None
deleted	bool	Whether to include deleted vpop generators.	False

Yields:

• VpopDesign: VpopDesign objects.

get_vpop_design

get_vpop_design(
    sid: str, *, revision: int | None = None, allow_deleted: bool = False
) -> VpopDesign

Get a vpop generator by SID.

Parameters:

Name	Type	Description	Default
sid	str	The SID of the vpop generator.
revision	int | None	Optional revision number.	None
allow_deleted	bool	Whether to allow retrieving deleted vpop generators.	False

Returns:

• VpopDesign: The requested VpopDesign.

create_vpop_design_from_json

create_vpop_design_from_json(
    *,
    json_content: dict[str, Any] | bytes | str | None = None,
    json_file_path: str | Path | None = None,
    name: str | None = None,
    folder: Folder | str | None = None,
    description: str | None = None,
    version: str | dict | None = None
) -> VpopDesign

Create a vpop generator from a raw JSON payload.

Exactly one of json_content or json_file_path must be provided.

Parameters:

Name	Type	Description	Default
json_content	dict[str, Any] | bytes | str | None	The vpop generator payload as a dict, JSON bytes, or JSON string.	None
json_file_path	str | Path | None	Path to a JSON file containing the payload.	None
name	str | None	Optional name for the new project item.	None
folder	Folder | str | None	Optional destination folder.	None
description	str | None	Optional description for the new project item.	None
version	str | dict | None	Optional version name str. Can also be a dict with the keys name and description to set a version description.	None

Returns:

• VpopDesign: The created VpopDesign.

create_vpop_design_from_design

create_vpop_design_from_design(
    *,
    model: Model | None = None,
    correlations: dict[tuple[str, str], float] | None = None,
    marginal_categoricals: dict[str, dict[str, float]] | None = None,
    marginal_distributions: (
        dict[str, dict[str, Any] | float | str] | None
    ) = None,
    folder: Folder | str | None = None,
    name: str | None = None,
    description: str | None = None,
    version: str | dict | None = None
) -> VpopDesign

Create a vpop generator from a statistical design.

correlations maps (x, y) variable id pairs to their Pearson correlation coefficient.

marginal_categoricals maps each variable id to a dict of category labels and their probabilities.

marginal_distributions maps each variable id to its marginal distribution. Each value can be a distribution dict (e.g. {"tag": "Normal", "mean": 0, "std": 1}), a float (interpreted as a constant), or a string (interpreted as a formula).

Parameters:

Name	Type	Description	Default
model	Model | None	Optional Model whose parameter definitions anchor the generator.	None
correlations	dict[tuple[str, str], float] | None	Optional pairwise correlations between variables.	None
marginal_categoricals	dict[str, dict[str, float]] | None	Optional categorical distributions per variable.	None
marginal_distributions	dict[str, dict[str, Any] | float | str] | None	Optional marginal distributions per variable.	None
folder	Folder | str | None	Optional destination folder.	None
name	str | None	Optional name for the new project item.	None
description	str | None	Optional description for the new project item.	None
version	str | dict | None	Optional version name str. Can also be a dict with the keys name and description to set a version description.	None

Returns:

• VpopDesign: The created VpopDesign.