Download and read a StatCan IVT table in one step — ivt_read_table • canivt

Convenience wrapper that ivt_download()s a table by product id and then read_ivt()s it.

Usage

ivt_read_table(pid, dest_dir = NULL, lang = c("en", "fr"), ...)

Arguments

pid: StatCan product id, e.g. "98100241" or 9810024101. Any trailing version digits are dropped to the 8-digit table id.
dest_dir: Directory to download into (created if needed). Defaults to a per-table folder under the IVT cache (ivt_cache_dir("ivt"), i.e. option canivt.ivt_cache or tempdir() when unset).
lang: "en" (default) or "fr" endpoint.
...: Passed to ivt_download().

Value

An ivt object (see read_ivt()), or NULL (invisibly, with a warning) if the table could not be downloaded (e.g. offline).

Examples

# Downloads from Statistics Canada. Returns NULL with a warning if offline
# (no error), so no try() is needed.
# \donttest{
tab <- ivt_read_table("98100241")
if (!is.null(tab)) {
  ivt_write_parquet(tab, file.path(tempdir(), "98100241.parquet"))
  ivt_write_metadata(tab, file.path(tempdir(), "98100241_metadata"))
}
# }