get_cansim_table_overview: Retrieve Statistics Canada data table overview text

get_cansim_table_overviewR Documentation

Retrieve Statistics Canada data table overview text

Description

Prints table overview information as console output. In order to display table overview information, the selected CANSIM table must be loaded entirely to display overview information. Overview information is printed in console an in English or French, as specified.

Usage

get_cansim_table_overview(
  cansimTableNumber,
  language = "english",
  refresh = FALSE
)

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)

Value

none

Examples

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

## End(Not run)

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