get_cansim_table_notes: Retrieve Statistics Canada data table notes and column...

get_cansim_table_notesR Documentation

Retrieve Statistics Canada data table notes and column categories

Description

Returns table notes 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_table_notes(
  cansimTableNumber,
  language = "en",
  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 table notes.

Examples

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

## End(Not run)

cansim documentation built on May 10, 2022, 9:06 a.m.