get_statcan_wds_metadata

Get official metadata information from Statistics Canada for a given geographic level. Only available for the 2021 census.
Data is cached for the duration of the R session.

Integrated, convenient, and uniform access to Canadian
Census data and geography retrieved using the 'CensusMapper' API. This package produces analysis-ready
tidy data frames and spatial data in multiple formats, as well as convenience functions
for working with Census variables, variable hierarchies, and region selection. API
keys are freely available with free registration at <https://censusmapper.ca/api>.
Census data and boundary geometries are reproduced and distributed on an "as
is" basis with the permission of Statistics Canada (Statistics Canada 2001; 2006;
2011; 2016; 2021).

Dmitry Shkolnik

cancensus

Access, Retrieve, and Work with Canadian Census Data and
Geography

Jens von Bergmann

Aaron Jacobs

get_statcan_wds_metadata function

<dl><dt>census_year</dt>
<dd>census year to get the data for, right now only 2021 is supported</dd>
<dt>level</dt>
<dd>geographic level to return the data for, valid choices are
"PR","CD","CMACA","CSD","CT","ADA","DA","ER","FED","DPL","POPCNTR", "FSA"</dd>
<dt>version</dt>
<dd>optionally specify a version of the data to download. For example, for FED level data, version 1.3 will
access the 2013 represenation order, whereas version 2.0 will access the 2023 representation order. By default the latest
available version is accessed.</dd>
<dt>refresh</dt>
<dd>default is `FALSE` will refresh the temporary cache if `TRUE`</dd></dl>

Arguments

Query the StatCan WDS for metadata — get_statcan_wds_metadata

<dl>

<dt>census_year</dt>
<dd>census year to get the data for, right now only 2021 is supported</dd>


<dt>level</dt>
<dd>geographic level to return the data for, valid choices are
"PR","CD","CMACA","CSD","CT","ADA","DA","ER","FED","DPL","POPCNTR", "FSA"</dd>


<dt>version</dt>
<dd>optionally specify a version of the data to download. For example, for FED level data, version 1.3 will
access the 2013 represenation order, whereas version 2.0 will access the 2023 representation order. By default the latest
available version is accessed.</dd>


<dt>refresh</dt>
<dd>default is `FALSE` will refresh the temporary cache if `TRUE`</dd>

</dl>

get_statcan_wds_metadata: Query the StatCan WDS for metadata

Description

Usage

Value

Arguments

Examples