pycancensus.label_vectors

pycancensus.label_vectors(x)[source]

Return Census variable names and labels from a data frame.

This function extracts the census_vectors attribute from a DataFrame returned by get_census() when labels=’short’. The attribute contains a mapping of truncated vector names to their detailed descriptions.

Parameters:: x (pd.DataFrame or gpd.GeoDataFrame) – A data frame returned from get_census() with labels=’short’.
Returns:: A DataFrame with columns ‘Vector’ (short code) and ‘Detail’ (full description), or None if no vector metadata is available.
Return type:: pd.DataFrame or None

Examples

>>> import pycancensus as pc
>>> # Get census data with short labels
>>> data = pc.get_census(
...     dataset='CA21',
...     regions={'CMA': '35535'},
...     vectors=['v_CA21_1', 'v_CA21_2'],
...     level='CSD',
...     labels='short'
... )
>>> # Get the vector label details
>>> labels = pc.label_vectors(data)
>>> print(labels)