Retrieves a data table using an NDM catalogue number as a tidy data frame. Retrieved table data is cached for the duration of the current R session only by default.
Usage
get_cansim(
cansimTableNumber,
language = "english",
refresh = FALSE,
timeout = 200,
factors = TRUE,
default_month = "07",
default_day = "01"
)
Arguments
- cansimTableNumber
the NDM table number to load
- language
"en"
or"english"
for English and"fr"
or"french"
for French language versions (defaults to English)- refresh
(Optional) When set to
TRUE
, forces a reload of data table (default isFALSE
)- timeout
(Optional) Timeout in seconds for downloading cansim table to work around scenarios where StatCan servers drop the network connection.
- factors
(Optional) Logical value indicating if dimensions should be converted to factors. (Default set to
TRUE
).- default_month
The default month that should be used when creating Date objects for annual data (default set to "07")
- default_day
The default day of the month that should be used when creating Date objects for monthly data (default set to "01") Set to higher values for large tables and slow network connection. (Default is
200
).