dcmri.fetch#
- dcmri.fetch(dataset=None, clear_cache=False, download_all=False)[source]#
Fetch a dataset included in dcmri
- Parameters:
dataset (str, optional) – name of the dataset. See below for options.
clear_cache (bool, optional) – When a dataset is fetched, it is downloaded and then stored in a local cache memory for faster access next time it is fetched. Set clear_cache=True to delete all data in the cache memory. Default is False.
download_all (bool, optional) – By default only the dataset that is fetched is downloaded. Set download_all=True to download all datasets at once. This will cost some time but then offers fast and offline access to all datasets afterwards. This will take up around 300 MB of space on your hard drive. Default is False.
- Returns:
Data as a dictionary.
- Return type:
Notes
The following datasets are currently available:
KRUK
tristan_humans_healthy_rifampicin
tristan_humans_healthy_metformin
tristan_humans_healthy_ciclosporin
tristan_humans_healthy_controls_leeds
tristan_humans_healthy_controls_sheffield
tristan_rats_healthy_six_drugs
tristan_rats_healthy_reproducibility
tristan_rats_healthy_multiple_dosing
Other
minipig_renal_fibrosis: Kidney data in a minipig with unilateral ureter stenosis. More detail in future versions..
Example:
Fetch the tristan_humans_healthy_rifampicin dataset and read it:
>>> import dcmri as dc >>> import pydmr
# fetch dmr file >>> file = dc.fetch(‘tristan_humans_healthy_rifampicin’)
# read dmr file >>> data = pydmr.read(file)