R/census_regions.R
list_census_regions.Rd
Query the CensusMapper API for available regions in a given dataset.
list_census_regions(dataset, use_cache = TRUE, quiet = FALSE)
The dataset to query for available regions, e.g.
"CA16"
.
If set to TRUE (the default), data will be read from a local cache that is maintained for the duration of the R session, if available. If set to FALSE, query the API for the data, and refresh the local cache with the result.
When TRUE, suppress messages and warnings.
Returns a data frame with the following columns:
region
The region identifier.
name
The name of that region.
level
The census aggregation level of that region.
pop
The population of that region.
municipal_status
Additional identifiers to distinguish the municipal status of census subdivisions.
CMA_UID
The identifier for the Census Metropolitan Area the region is in (if any).
CD_UID
The identifier for the Census District the region is in (if any).
PR_UID
The identifier for the Province the region is in (if unique).
list_census_regions('CA16')
#> Reading regions list from local cache.
#> # A tibble: 5,518 × 8
#> region name level pop munic…¹ CMA_UID CD_UID PR_UID
#> <chr> <chr> <chr> <int> <chr> <chr> <chr> <chr>
#> 1 01 Canada C 35151728 NA NA NA NA
#> 2 35 Ontario PR 13448494 NA NA NA NA
#> 3 24 Quebec PR 8164361 NA NA NA NA
#> 4 59 British Columbia PR 4648055 NA NA NA NA
#> 5 48 Alberta PR 4067175 NA NA NA NA
#> 6 46 Manitoba PR 1278365 NA NA NA NA
#> 7 47 Saskatchewan PR 1098352 NA NA NA NA
#> 8 12 Nova Scotia PR 923598 NA NA NA NA
#> 9 13 New Brunswick PR 747101 NA NA NA NA
#> 10 10 Newfoundland and Labrador PR 519716 NA NA NA NA
#> # … with 5,508 more rows, and abbreviated variable name ¹municipal_status