runpandas.activity_examples

runpandas.activity_examples(path=None, file_type=None, config=None, **kwargs)

Load an example activity from the online repository (requires internet).

This function provides quick access to a small number of example datasets that are useful for documenting runpandas or generating reproducible examples for tests. It is not necessary for normal usage.

Use _get_activity_index() to see a list of available datasets.

Parameters

• name (str, optional) – Name of the dataset (path on corriporai/runpandas-data).

• file_type (str) – Iterates over all files with the given file type and return them.

• config (yaml file, optional) – The directory in which to cache data; see get_cache_path().

• kwargs (keys and values, optional) – Additional keyword arguments are passed to passed through to runpandas.read_file().

Returns

loaded_data

Return type

a single or a list of schema.ActivityData instances.