Package: cancensus 0.6.0

Dmitry Shkolnik

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

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 1996; 2001; 2006; 2011; 2016; 2021).

Authors:Jens von Bergmann [aut], Dmitry Shkolnik [aut, cre], Aaron Jacobs [aut]

cancensus_0.6.0.tar.gz
cancensus_0.6.0.zip(r-4.7)cancensus_0.6.0.zip(r-4.6)cancensus_0.6.0.zip(r-4.5)
cancensus_0.6.0.tgz(r-4.6-any)cancensus_0.6.0.tgz(r-4.5-any)
cancensus_0.6.0.tar.gz(r-4.7-any)cancensus_0.6.0.tar.gz(r-4.6-any)
cancensus_0.6.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
cancensus/json (API)

# Install 'cancensus' in R:
install.packages('cancensus', repos = c('https://mountainmath.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/mountainmath/cancensus/issues

Pkgdown/docs site:https://mountainmath.github.io

Datasets:

On CRAN:

Conda:

9.52 score 89 stars 732 scripts 1.1k downloads 33 exports 51 dependencies

Last updated from:8ff2340dac. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK184
source / vignettesOK244
linux-release-x86_64OK179
macos-release-arm64OK93
macos-oldrel-arm64OK92
windows-develOK144
windows-releaseOK118
windows-oldrelOK147
wasm-releaseOK153

Exports:add_unique_names_to_region_listas_census_region_listcensus_vectorschild_census_vectorsdataset_attributionexplore_census_regionsexplore_census_vectorsfind_census_vectorsget_censusget_census_geometryget_intersecting_geometriesget_statcan_geo_suiteget_statcan_geographic_attributesget_statcan_geographiesget_statcan_geography_relationshipsget_statcan_wds_dataget_statcan_wds_metadatalabel_vectorslist_cancensus_cachelist_census_datasetslist_census_regionslist_census_vectorslist_recalled_cached_dataparent_census_vectorsremove_from_cancensus_cacheremove_recalled_cached_datasearch_census_regionssearch_census_vectorsset_cancensus_api_keyset_cancensus_cache_pathshow_cancensus_api_keyshow_cancensus_cache_pathvisualize_vector_hierarchy

Dependencies:askpassbitbit64classclassIntclicliprcpp11crayoncurlDBIdigestdplyre1071genericsgeojsonsfgeometriesgluehmshttrjsonifyjsonliteKernSmoothlifecyclemagrittrMASSmimeopensslpillarpkgconfigprettyunitsprogressproxyR6rapidjsonrRcppreadrrlangs2sfsfheaderssystibbletidyselecttzdbunitsutf8vctrsvroomwithrwk

Additional datasets: Annual T1FF taxfiler data
Background | Example usage: constructing a multi-year series of families in low-income status
Rendered fromTaxfiler_Data.Rmdusingknitr::rmarkdown

Last update: 2025-11-06
Started: 2020-06-21

Additional datasets: Structural type of dwelling by document type
Background | Example usage: buildings unoccupied vs not occupied by usual residents
Rendered fromDwellings_by_document_type_cross_tabulation.Rmdusingknitr::rmarkdown

Last update: 2025-11-06
Started: 2020-06-21

cancensus
Cancensus and CensusMapper | API Key | Installing cancensus | Accessing Census Data | Census Datasets | Census Regions | Census Geographic Levels | Working with Census Variables | Displaying available Census variables | Variable characteristics | Variable search | Managing variable hierarchy
Rendered fromcancensus.Rmdusingknitr::rmarkdown

Last update: 2025-11-06
Started: 2017-11-17

Data discovery
Census datasets | Variable vectors | View available Census variable vectors | Searching for Census variable vectors | Exact search | Keyword search | Semantic search | Census regions | Standard Geographical Classification | A note on Census Metropolitan Areas and Census Agglomerations | Aside: dissemination areas, blocks, and enumeration areas | Viewing available Census regions | Searching through named Census regions | Exploring Census variable vectors and regions interactively
Rendered fromdata_discovery.Rmdusingknitr::rmarkdown

Last update: 2025-11-06
Started: 2020-06-21

Finding intersecting geometries from custom data
A simple example | Addendum
Rendered fromintersecting_geometries.Rmdusingknitr::rmarkdown

Last update: 2025-11-06
Started: 2021-01-11

Making maps with cancensus
Spatial data in cancensus | Maps with base R graphics | Maps with ggplot2 | Interactive maps with leaflet
Rendered fromMaking_maps_with_cancensus.Rmdusingknitr::rmarkdown

Last update: 2025-11-06
Started: 2017-11-17

StatCan WDS
Word of caution | Ukrainians by Federal Electoral Districts
Rendered fromstatcan_wds.Rmdusingknitr::rmarkdown

Last update: 2025-11-06
Started: 2023-01-23

StatCan attribute files
Background | Match between Census Tracts and Census Subdivisions
Rendered fromstatcan_attribute_files.Rmdusingknitr::rmarkdown

Last update: 2023-01-23
Started: 2023-01-23

Readme and manuals

Help Manual

Help pageTopics
Convenience function for creating unique names from region listadd_unique_names_to_region_list
Convert a (suitably filtered) data frame from 'list_census_regions' to a list suitable for passing to 'get_census'.as_census_region_list
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.child_census_vectors
A dataset with code table summaries for census dataCODES_TABLE
A dataset City of Vancouver skytrain station locationsCOV_SKYTRAIN_STATIONS
Get attribution for datasetsdataset_attribution
Interactively browse Census variables and regions on Censusmapper.ca in a new browser windowexplore_census_regions
Interactively browse Census variables and regions on Censusmapper.ca in a new browser windowexplore_census_vectors
Query the CensusMapper API for vectors using exact, semantic, or keyword searchfind_census_vectors
Access to Canadian census data through the CensusMapper APIget_census
Get identifiers for census regions intersecting a geometryget_intersecting_geometries
Read the geosuite dataget_statcan_geo_suite
Read the Geographic Attributes Fileget_statcan_geographic_attributes
Read the geosuite dataget_statcan_geographies
Query the StatCan WDS for dataget_statcan_wds_data
Query the StatCan WDS for metadataget_statcan_wds_metadata
Return Census variable names and labels as a tidy data framelabel_vectors
List cached fileslist_cancensus_cache
Query the CensusMapper API for available datasets.list_census_datasets
Query the CensusMapper API for available regions in a given dataset.list_census_regions
Query the CensusMapper API for available vectors for a given dataset.list_census_vectors
List recalled data stored in local cachelist_recalled_cached_data
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.parent_census_vectors
Remove cached filesremove_from_cancensus_cache
Remove recalled data from local cacheremove_recalled_cached_data
Query the CensusMapper API for regions with names matching a searchterm.search_census_regions
Query the CensusMapper API for vectors with descriptions matching a search term or phrase (deprecated)search_census_vectors
Set Censusmapper API keyset_cancensus_api_key
Set persistent cancensus cache locationset_cancensus_cache_path
View saved Censusmapper API keyshow_cancensus_api_key
View saved cache directory pathshow_cancensus_cache_path
Visualize Census vector hierarchies as ASCII treevisualize_vector_hierarchy