tams.data.fetch_example

Contents

tams.data.fetch_example#

tams.data.fetch_example(key, *, progress=False)#

Retrieve an example data file using pooch and gdown.

Parameters:

  • key (str) – String identifying which example file to retrieve.

  • progress (bool) – Show download progress.

Return type:

Path

Examples

>>> import tams
>>> path = tams.data.fetch_example("msg-tb")

See also

open_example, load_example

Notes

Added in version 0.2.0.

Contents