pycancensus.list_recalled_cached_data

pycancensus.list_recalled_cached_data(cached_data: DataFrame | None = None) → DataFrame | None

List locally cached data that has been recalled by Statistics Canada.

Only cache entries written by pycancensus versions that record request metadata (dataset, vectors, data version) can be checked.

Parameters:

cached_data (pd.DataFrame, optional) – Cache listing to check, as returned by list_cache(). Defaults to the full local cache.

Returns:

Rows of list_cache() describing recalled entries, or None if the recall database could not be downloaded.

Return type:

pd.DataFrame or None

Examples

>>> import pycancensus as pc
>>> pc.list_recalled_cached_data()