get_cansim_table_info: Retrieve Statistics Canada data table information

get_cansim_table_infoR Documentation

Retrieve Statistics Canada data table information

Description

Returns table information given an NDM table catalogue number in English or French. Retrieved table information data is cached for the duration of the R session only.

Usage

get_cansim_table_info(
  cansimTableNumber,
  language = "english",
  refresh = FALSE,
  timeout = 200
)

Arguments

cansimTableNumber

the NDM table number to load

language

"en" or "english" for English and "fr" or "french" for French language versions (default set to English)

refresh

(Optional) When set to TRUE, forces a reload of data table (default is FALSE)

timeout

(Optional) Timeout in seconds for downloading cansim table to work around scenarios where StatCan servers drop the network connection.

Value

A tibble with the table overview information

Examples

## Not run: 
get_cansim_table_info("34-10-0013")

## End(Not run)

cansim documentation built on May 29, 2024, 2:46 a.m.