supported_datasets.list_supported_datasets()

List all datasets supported by ‘download_data’.

Usage

Source

supported_datasets.list_supported_datasets(
    domain=None,
    as_vector=False,
)

Aggregates the Global Q, Fama-French, Goyal-Welch, WRDS, Pseudo Data, and “other” tables into a single :class:‘polars.DataFrame’. The legacy Fama-French table is intentionally excluded from the master listing.

Parameters

domain: str or list of str = None

Restrict the result to one or more domain labels (for example ‘WRDS’ or ‘[’Fama-French’, ’Global Q’]’).

as_vector: bool = False

When ‘True’, return a list of ‘type’ strings instead of a DataFrame.

Returns

polars.DataFrame or list of str

Either a DataFrame with columns ‘type’, ‘dataset_name’, and ‘domain’, or a list of ‘type’ strings when ‘as_vector=True’.

Examples

from tidyfinance import list_supported_datasets
list_supported_datasets()
list_supported_datasets(domain='WRDS')
list_supported_datasets(as_vector=True)