pypmi.fetch_studydata

pypmi.fetch_studydata(*datasets, path: str = None, user: str = None, password: str = None, overwrite: bool = False, verbose: bool = True) → List[str][source]

Downloads specified study data datasets from the PPMI database

Parameters:
  • *datasets (str) – Datasets to download. Can provide as many as desired, but they should be listed in pypmi.fetchable_studydata(). Alternatively, if any of the provided values are ‘all’, then all available datasets will be fetched.
  • path (str, optional) – Filepath where downloaded data should be saved. If data files already exist at path they will be overwritten unless overwrite=False. If not supplied the current directory is used. Default: None
  • user (str, optional) – Email for user authentication to the LONI IDA database. If not supplied will look for $PPMI_USER variable in environment. Default: None
  • password (str, optional) – Password for user authentication to the LONI IDA database. If not supplied will look for $PPMI_PASSWORD variable in environment. Default: None
  • overwrite (bool, optional) – Whether to overwrite existing PPMI data files at path if they already exist. Default: False
  • verbose (bool, optional) – Whether to print progress bar as download occurs. Default: True
Returns:

downloaded – Filepath(s) to downloaded datasets
Return type:

list

See also

pypmi.fetchable_studydata()