get_cansim_column_categories {cansim}R Documentation

Retrieve Statistics Canada data table categories for a specific column

Description

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

Usage

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

Arguments

cansimTableNumber

the NDM table number to load

column

the specified column for which to retrieve category information for

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 detailed information on StatCan table categories for the specified field

Examples


get_cansim_column_categories("34-10-0013", "Geography")


[Package cansim version 0.3.8 Index]