Reference

Retrieving Census data

get_census()

Access to Canadian census data through the CensusMapper API

Data discovery

list_census_datasets()

Query the CensusMapper API for available datasets.

list_census_regions()

Query the CensusMapper API for available regions in a given dataset.

as_census_region_list()

Convert a (suitably filtered) data frame from list_census_regions to a list suitable for passing to get_census.

list_census_vectors()

Query the CensusMapper API for available vectors for a given dataset.

find_census_vectors()

Query the CensusMapper API for vectors using exact, semantic, or keyword search

search_census_regions()

Query the CensusMapper API for regions with names matching a searchterm.

explore_census_vectors()

Interactively browse Census variables and regions on Censusmapper.ca in a new browser window

explore_census_regions()

Interactively browse Census variables and regions on Censusmapper.ca in a new browser window

search_census_vectors()

Query the CensusMapper API for vectors with descriptions matching a search term or phrase (deprecated)

get_intersecting_geometries()

Get identifiers for census regions interesecting a geometry

Working with Census data

label_vectors()

Return Census variable names and labels as a tidy data frame

child_census_vectors()

List all child variables from vector hierarchies given either a list of Census variables returned by list_census_vectors, search_census_vectors, find_census_vectors, or a direct string reference to the vector code.

parent_census_vectors()

List all parent variables from vector hierarchies given either a list of Census variables returned by list_census_vectors, search_census_vectors, find_census_vectors, or a direct string reference to the vector code.

dataset_attribution()

Get attribution for datasets

Managing cached data

list_cancensus_cache()

List cached files

remove_from_cancensus_cache()

Remove cached files

User settings

set_api_key()

Set Censusmapper API key

set_cache_path()

Set persistent cancensus cache location

show_api_key()

View saved Censusmapper API key

show_cache_path()

View saved cache directory path