list_tar_files_in_region_folder

ukbppp_dl.pgwas.list_tar_files_in_region_folder(synapse_id: str = 'syn51365308', login_kwargs: Dict[str, Any] = {}) → List[Tuple[str, str]]

List all protein tar files in the folder of given GWAS region.

Parameters:

  • synapse_id (str, optional) – Synapse folder ID for the GWAS region, e.g. "syn51365308" for the Combined ancestry group. Defaults to PGWAS_REGIONS["Combined"].

  • login_kwargs (Dict[str, Any], optional) –

    Keyword arguments forwarded to synapseclient.Synapse.login(). Common keys include "authToken" (str), "email" (str) and "profile" (str). See synapseclient.Synapse.login() for more information.

    Alternatively, you can configure your Synapse credentials in a .synapseConfig file and leave this argument empty to use the default login behaviour. You can find more information about .synapseConfig in the Synapse documentation.

Returns:

Sorted list of (synapse_id, tar_filename) pairs, one per protein tar file found in the folder. Example entry: [("syn52361344", "ABCA2_Q9BZC7_OID30146_v1_Cardiometabolic_II.tar"), ("syn51470065", "ABHD14B_Q96IU4_OID20921_v1_Neurology.tar.tar")].

Return type:

List[Tuple[str, str]]