| get_census | R Documentation |
This function allows convenient access to Canadian census data and boundary files through the CensusMapper API. An API key is required to retrieve data.
get_census(
dataset,
regions,
level = NA,
vectors = c(),
geo_format = NA,
resolution = "simplified",
labels = getOption("cancensus.labels", "detailed"),
use_cache = TRUE,
quiet = FALSE,
api_key = Sys.getenv("CM_API_KEY"),
retry = 0,
language = getOption("cancensus.language", "en")
)
dataset |
A CensusMapper dataset identifier. |
regions |
A named list of census regions to retrieve. Names must be valid census aggregation levels. |
level |
The census aggregation level to retrieve, defaults to |
vectors |
An R vector containing the CensusMapper variable names of the census variables to download. If no vectors are specified only geographic data will get downloaded. Naming the elements of the vector sets the names of the columns, e.g. |
geo_format |
By default is set to |
resolution |
Resolution of the geographic data. By default simplified geometries will be download. For lower level geometries like DB or DA this will be very close to the high resolution data.
Simplification generally increases as the geographic aggregation level increases.
If high resolution geometries are required
then this option can be set to 'high'. By default this setting is set to |
labels |
Defaults to the |
use_cache |
If set to TRUE (the default) data will be read from the local cache if available. |
quiet |
When TRUE, suppress messages and warnings. |
api_key |
An API key for the CensusMapper API. Defaults to |
retry |
Integer If greater than zero, automatically retry API requests that fail with a network error or a transient server error (HTTP 408, 502 or 504) with exponential backoff for specified maximum number of times. Defaults to 0. Requests are always retried at least twice when the server is busy (HTTP 503 or 429), waiting as long as the server asks. |
language |
Language of the Census variable labels, one of |
For help selecting regions and vectors, see list_census_regions
and list_census_vectors, or check out the interactive selection
tool at https://censusmapper.ca/api by calling explore_census_vectors()
Census data and boundary geographies are reproduced and distributed on an "as is" basis with the permission of Statistics Canada (Statistics Canada 1996; 2001; 2006; 2011; 2016).
# Query the API for data on dwellings in Vancouver, at the census subdivision
# level:
## Not run:
census_data <- get_census(dataset='CA16', regions=list(CMA="59933"),
vectors=c("v_CA16_408","v_CA16_409","v_CA16_410"),
level='CSD')
# Query the API for data on dwellings in Vancouver, at the census subdivision
# level, and return the associated geography files in \code{sf} format:
census_data <- get_census(dataset='CA16', regions=list(CMA="59933"),
vectors=c("v_CA16_408","v_CA16_409","v_CA16_410"),
level='CSD', geo_format = "sf")
# Make the same query, but this time drop descriptive vector names:
census_data <- get_census(dataset='CA16', regions=list(CMA="59933"),
vectors=c("v_CA16_408","v_CA16_409","v_CA16_410"),
level='CSD', geo_format = "sf", labels="short")
# Get details for truncated vectors:
label_vectors(census_data)
# Name columns by vector, with the labels in the "label" attribute of the columns:
census_data <- get_census(dataset='CA16', regions=list(CMA="59933"),
vectors=c("v_CA16_408","v_CA16_409","v_CA16_410"),
level='CSD', labels="labelled")
attr(census_data$v_CA16_408, "label")
# Get the labels in French:
census_data <- get_census(dataset='CA16', regions=list(CMA="59933"),
vectors=c("v_CA16_408","v_CA16_409","v_CA16_410"),
level='CSD', language="fr")
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.