pytidycensus.load_variables

pytidycensus.load_variables(year, dataset=None, survey=None, cache=True, cache_dir=None)[source]

Load Census variables for a given dataset and year.

Parameters:

  • year (int) – Census year

  • dataset (Optional[str]) – Dataset name (‘acs’, ‘dec’, ‘pep’, etc.). Provide either dataset or survey.

  • survey (Optional[str]) – Survey type (e.g., ‘acs5’, ‘acs1’, ‘sf1’, ‘pl’). If provided, the dataset will be inferred from the survey. Provide either dataset or survey, not both.

  • cache (bool) – Whether to cache variables for faster future access

  • cache_dir (Optional[str]) – Directory for caching. Defaults to user cache directory.

Returns:

Variables with columns: name, label, concept, predicateType, group, limit

Return type:

DataFrame

Examples

>>> # Load ACS 5-year variables for 2022
>>> acs_vars = load_variables(2022, "acs", "acs5")
>>>
>>> # Search for income-related variables
>>> income_vars = acs_vars[acs_vars['label'].str.contains('income', case=False)]
>>>
>>> # Load decennial census variables for 2020
>>> dec_vars = load_variables(2020, "dec", "pl")