get_cansim_vector: Retrieve data for a Statistics Canada data vector released...

In cansim: Accessing Statistics Canada Data Table and Vectors

Retrieve data for a Statistics Canada data vector released within a given time frame

Description

Retrieve data for a Statistics Canada data vector released within a given time frame

Usage

get_cansim_vector(
  vectors,
  start_time = as.Date("1800-01-01"),
  end_time = Sys.time(),
  use_ref_date = TRUE,
  language = "english",
  refresh = FALSE,
  timeout = 200,
  factors = TRUE,
  default_month = "07",
  default_day = "01"
)

Arguments

vectors	The list of vectors to retrieve
start_time	Starting date in YYYY-MM-DD format, applies to REF_DATE or releaseTime, depending on use_ref_date parameter
end_time	Set an optional end time filter in YYYY-MM-DD format (defaults to current system time)
use_ref_date	Optional, TRUE by default. When set to TRUE, uses REF_DATE of vector data to filter, otherwise it uses StatisticsCanada's releaseDate value for filtering the specified vectors.
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)
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")

Value

A tibble with data for vectors released between start and end time

Examples

## Not run: 
get_cansim_vector("v41690973","2015-01-01")

## End(Not run)

cansim documentation built on April 3, 2025, 10:26 p.m.