nispace.datasets.fetch_map_info

nispace.datasets.fetch_map_info(dataset, maps=None, overwrite=False, check_file_hash=True, nispace_data_dir=None, verbose=True)[source]

Fetch a dataset’s per-map metadata table (e.g. sample size, tracer, condition).

Parameters:

  • dataset (str) – Name of an integrated reference dataset (see fetch_reference()).

  • maps (str or list of str, optional) – Restrict the returned table to these map IDs. None returns all.

  • overwrite (bool, default False) – Re-download the metadata file even if already cached locally.

  • check_file_hash (bool, default True) – Verify the SHA-256 hash of the cached file against the known reference hash.

  • nispace_data_dir (str or Path, optional) – Deprecated; use the NISPACE_DATA_DIR environment variable instead.

  • verbose (bool, default True) – Print progress messages.

Returns:

Metadata table indexed by map name, or None if dataset is not a string, is not registered, or has no metadata table.

Return type:

pd.DataFrame or None