framex.available#

available(includes: str | None = None, *, option: Literal['remote', 'local'] | None = None) → dict[str, list[str]] | list[str]#

List available datasets.

Parameters:

includes (str, optional) – A string to filter the available datasets. Default is None
option (str, optional {'remote', 'local'}) – The option to list available datasets. Default is None

Returns:

list of available datasets

Raises:

ValueError – If the option is not ‘remote’ or ‘local’.

Examples

Finding datasets which includes the given string in its name.

import framex as fx

fx.available('dia')

{'remote': ['diamonds'], 'local': ['diamonds']}

To check only locally cached datasets.

import framex as fx

fx.available(option='local') # option='remote' for remote only datasets

['birds', 'diamonds', 'iris', 'mpg', 'penguins', 'titanic']

To see all the datasets available, local or remote.

import framex as fx

fx.available()

{'remote': ['abortion',
  'absentee',
  'airlines',
  'airports',
  'Alligator',
  'anorexia',
  'Arrests',
  'arthritis',
  'auto',
  'avocado',
  'babies',
  'BeeStings',
  'BirdCalcium',
  'BirdNest',
  'birds',
  'Births',
  'Caterpillars',
  'cherry',
  'Chicago',
  'Chile',
  'Cholera',
  'coffee_price',
  'College',
  'CollegeDistance',
  'comics',
  'commodity_prices',
  'concrete',
  'constants',
  'Contraceptives',
  'country_codes',
  'covid_testing',
  'cpu',
  'crabs',
  'Credit',
  'defects',
  'Diabetes',
  'diamonds',
  'earthquakes',
  'epilepsy',
  'films',
  'fishing',
  'Fitch',
  'flights',
  'Forbes2000',
  'FruitFlies',
  'Gasoline',
  'Gestation',
  'gpa',
  'HealthInsurance',
  'iris',
  'Journals',
  'Ketchup',
  'london_murders',
  'Mortgage',
  'mpg',
  'Municipalities',
  'murders',
  'nba_finals',
  'nba_heights',
  'netflix',
  'oils',
  'olive',
  'oscars',
  'paris2024',
  'penguins',
  'planes',
  'pokemon',
  'population',
  'PorscheJaguar',
  'Pottery',
  'president',
  'Salaries',
  'species',
  'starbucks',
  'stars',
  'storms',
  'titanic',
  'Train',
  'UN',
  'usa_migration',
  'usa_states',
  'Utilities',
  'water',
  'weather',
  'Wells',
  'wine',
  'Yogurt'],
 'local': ['birds', 'diamonds', 'iris', 'mpg', 'penguins', 'titanic']}