get_performances(
ppm_id: str = None,
pgs_id: str = None,
pgp_id: str = None,
pmid: int = None,
cached: bool = True,
mode: str = "Fat",
) -> PerformanceMetric
Get PerformanceMetrics data from the server.
| Parameters: |
-
ppm_id
(str, default:
None
)
–
PGS Performance Metric ID (PPM).
-
pgs_id
(str, default:
None
)
–
Polygenic Score ID (PGS).
-
pgp_id
(str, default:
None
)
–
PGS Catalog Publication ID (PGP).
-
pmid
(int, default:
None
)
–
PubMed ID (without the prefix "PMID:").
-
cached
(bool, default:
True
)
–
Whether or not to try to get data from the cache.
-
mode
(str, default:
'Fat'
)
–
Fat or Thin. Specifies the mode of the returned object.
|
| Returns: |
-
PerformanceMetric
–
A PerformanceMetrics object. Attributes of type DataFrame have hierarchical dependencies.
|
from pandaspgs.get_performance import get_performances
ch = get_performances(ppm_id='PPM000001')