cansim (version 0.4)

get_cansim_sqlite: Retrieve a Statistics Canada data table using NDM catalogue number as SQLite database connection

Description

Retrieves a data table using an NDM catalogue number as an SQLite table. Retrieved table data is cached permanently if a cache path is supplied or for duration of the current R session. The function will check against the lastest release data for the table and emit a warning message if the cached table is out of date.

Usage

get_cansim_sqlite(
  cansimTableNumber,
  language = "english",
  refresh = FALSE,
  auto_refresh = FALSE,
  timeout = 1000,
  cache_path = getOption("cansim.cache_path")
)

Value

A database connection to a local SQLite database with the StatCan Table data.

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 is FALSE)

auto_refresh

(Optional) When set to TRUE, it will reload of data table if a new version is available (default is FALSE)

timeout

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

cache_path

(Optional) Path to where to cache the table permanently. By default, the data is cached in the path specified by `getOption("cansim.cache_path")`, if this is set. Otherwise it will use `tempdir()`.

Examples

if (FALSE) {
con <- get_cansim_connection("34-10-0013", format="sqlite")

# Work with the data connection
gplimpse(con)

disconnect_cansim_sqlite(con)
}