Package index • cansim

Retrieving data

Retrieve data cubes, tables, and vectors from Statistics Canada

get_cansim(): Retrieve a Statistics Canada data table using NDM catalogue number

get_cansim_data_for_table_coord_periods(): Retrieve data for specified Statistics Canada data product for last N periods for specific coordinates

get_cansim_vector(): Retrieve data for a Statistics Canada data vector released within a given time frame

get_cansim_vector_for_latest_periods(): Retrieve data for specified Statistics Canada data vector(s) for last N periods

Local database caching

Managing data in local database

get_cansim_connection(): Retrieve a Statistics Canada data table using NDM catalogue number as parquet, feather, or sqlite database connection

collect_and_normalize(): Collect data from a parquet, feather or sqlite query and normalize cansim table output

list_cansim_cached_tables(): List cached cansim arrow and SQlite databases

remove_cansim_cached_tables(): Remove cached cansim SQLite and parquet database

disconnect_cansim_sqlite(): Disconnect from a cansim database connection

cansim_repartition_cached_table(): Repartitions a cached cansim table to a new partitioning scheme

set_cansim_cache_path(): Set persistent cansim cache location

show_cansim_cache_path(): View saved cache directory path

Locating data

Help with data discovery

list_cansim_cubes(): Get overview list for all Statistics Canada data cubes

search_cansim_cubes(): Search through Statistics Canada data cubes

get_cansim_changed_tables(): Retrieve a list of modified tables since a given date

get_cansim_table_last_release_date(): Get the latest release data for a StatCan table, if available

get_cansim_key_release_schedule(): Major economic indicator release schedule

Metadata and information

Browse metadata and table contents

get_cansim_cube_metadata(): Retrieve table metadata from Statistics Canada API

get_cansim_table_info(): Retrieve Statistics Canada data table information

get_cansim_table_last_release_date(): Get the latest release data for a StatCan table, if available

get_cansim_table_notes(): Retrieve Statistics Canada data table notes and column categories

get_cansim_table_overview(): Retrieve Statistics Canada data table overview text

get_cansim_table_short_notes(): Retrieve Statistics Canada data table short notes

get_cansim_table_subject(): Retrieve Statistics Canada data table subject detail

get_cansim_table_survey(): Retrieve Statistics Canada data table survey detail

get_cansim_table_template(): Retrieve table template from Statistics Canada API

get_cansim_table_url(): Retrieve a Statistics Canada data table URL given a table number

add_cansim_vectors_to_template(): Retrieve series info for given table id and coordinates

get_cansim_series_info_cube_coord(): Retrieve series info for given table id and coordinates

get_cansim_vector_info(): Retrieve metadata for specified Statistics Canada data vectors

get_cansim_column_categories(): Retrieve Statistics Canada data table categories for a specific column

get_cansim_column_list(): Retrieve Statistics Canada data table column list

view_cansim_webpage(): View CANSIM table or vector information in browser

categories_for_level(): Use metadata to extract categories for column of specific level

Miscellaneous

Helper functions

add_provincial_abbreviations(): Add provincial abbreviations as factor

cansim_old_to_new(): Translate deprecated CANSIM table number into new NDM-format table catalogue number

get_cansim_code_set(): Get NDM code sets