get_statcan_wds_metadata: Query the StatCan WDS for metadata

View source: R/wds.R

get_statcan_wds_metadataR Documentation

Query the StatCan WDS for metadata

Description

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.

Usage

get_statcan_wds_metadata(census_year, level, refresh = FALSE)

Arguments

census_year

census year to get the data for, right now only 2021 is supported

level

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

refresh

default is 'FALSE' will refresh the temporary cache if 'TRUE'

Value

tibble with the metadata

Examples

# get metadata for federal electoral districts
## Not run: 
get_statcan_wds_metadata(census_year="2021",level="FED")

## End(Not run)

cancensus documentation built on Oct. 5, 2023, 5:08 p.m.