pandaspgs.get_sample_set.get_sample_sets

get_sample_sets(
    pss_id: str = None,
    pgs_id: str = None,
    pgp_id: str = None,
    pmid: int = None,
    cached: bool = True,
    mode: str = "Fat",
) -> SampleSet

Get SampleSet data from the server.

Parameters:
  • pss_id (str, default: None ) –

    PGS Sample Set ID (PSS)

  • 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:
  • SampleSet

    A SampleSet object. Attributes of type DataFrame have hierarchical dependencies.

from pandaspgs.get_sample_set import get_sample_sets

ch = get_sample_sets(pss_id='PSS000001')