Package index • canivt

Finding and downloading tables

Catalogues of the published IVT products and the downloads into the ivt cache. The www12.statcan.gc.ca host sits behind a browser check; install safeconduct to pass it (see the README).

Statistics Canada

statcan_ivt_years(): Available census versions on the StatCan datasets index
statcan_ivt_catalogue(): Catalogue of StatCan Beyond 20/20 IVT products
statcan_ivt_resolve_url(): Resolve a published IVT link to its direct-download URL
statcan_ivt_download(): Download a StatCan IVT by its direct-download URL
ivt_download(): Download a Beyond 20/20 IVT table from Statistics Canada

Borealis Dataverse

borealis_ivt_catalogue(): Catalogue of Borealis Dataverse Beyond 20/20 IVT products
borealis_ivt_download(): Download a Borealis IVT file into the ivt cache

Reading a table

Decode an .ivt file into the published table, its codebook and footnotes, and label it.

read_ivt(): Read a Beyond 20/20 IVT file
ivt_read_table(): Download and read a StatCan IVT table in one step
ivt_metadata(): Read only the metadata of an IVT file (no value decoding)
ivt_tidy(): Tidy an ivt object into a labelled data frame
label_ivt_columns(): Relabel slug data columns with their full dimension names
ivt_members(): Member levels of an IVT table
collect_ivt(): Collect IVT data with dimension columns as factors

Flagged cells

The cell-status block, opt-in with read_ivt(missing = TRUE). Which absent cells are suppressed, not applicable, and so on, per the file’s own legend.

ivt_missing(): Get the cell-status (missing-cell) table
ivt_tidy_missing(): Tidy the cell-status (missing-cell) table

Writing to Parquet and CSV

ivt_write_parquet(): Write an IVT table to Parquet
ivt_write_csv(): Write an IVT table to CSV
ivt_write_metadata(): Write the table metadata (codebook + footnotes) to disk
ivt_parquet_language(): Detect the language of an IVT Parquet

The Parquet cache

One step from product id to an Arrow connection, and the cache behind it.

get_statcan_ivt(): Get a StatCan IVT table as a Parquet connection
ivt_cache_dir(): canivt cache directories
list_ivt_cache(): List the canivt cache contents
prune_ivt_cache(): Prune files from the canivt cache