rhino_health.lib.endpoints.cohort.cohort_dataclass
#
Module Contents#
Classes#
|
- class rhino_health.lib.endpoints.cohort.cohort_dataclass.Cohort(**data)#
Bases:
Cohort
- uid :str#
The unique ID of the Cohort
- name :str#
The name of the Cohort
- description :str#
The description of the Cohort
- base_version_uid :Optional[str]#
The original Cohort this Cohort is a new version of, if applicable
- version :Optional[int] = 0#
Which revision this Cohort is
- created_at :str#
When this Cohort was added
- num_cases :int#
The number of cases in the cohort
- cohort_info :Optional[dict]#
Sanitized metadata information about the cohort.
- import_status :str#
The import status of the cohort
- project_uid :str#
The unique ID of the Project this Cohort belongs to.
- workgroup_uid :str#
The unique ID of the Workgroup this Cohort belongs to
- data_schema_uid :str#
The unique ID of the DataSchema this Cohort follows
- data_schema_info :dict#
Metadata about the DataSchema for this cohort.
- create(self)#
- get_metric(self, metric_configuration)#
Queries on-prem and returns the result based on the METRIC_CONFIGURATION for this cohort.
See also
- property project(self)#
Get the project of this Cohort
Warning
Be careful when calling this for newly created objects. The project associated with the PROJECT_UID must already exist on the platform.
Warning
The result of this function is cached. Be careful calling this function after making changes to the project
- Returns
- project: Project
A DataClass representing the Project of the user’s primary workgroup
See also
rhino_health.lib.endpoints.project.project_dataclass
Project Dataclass