Skip to contents

Read an Ontario-Catalogue XLSX data-dictionary sidecar.

Source: R/arsau_datasets.R
morie_arsau_read_xlsx_dictionary.Rd

Some ARSAU releases ship a companion *.xlsx file alongside the CSV that holds the column-level data dictionary (variable name

  • dtype + notes). This helper reads the first sheet via readxl and normalises the column names to name / type / notes. Requires the optional readxl dependency.

Usage

morie_arsau_read_xlsx_dictionary(path, sheet = 1L)

Arguments

path

Path to the XLSX file.

sheet

Sheet identifier (name or 1-based integer). Default 1L.

Value

A data.frame with columns name, type, notes. Other columns from the XLSX are preserved with their upstream names.

References

Ontario Ministry of the Solicitor General data dictionaries accompanying the ARSAU CSV releases.

Examples

# \donttest{
# Point at a downloaded ARSAU data-dictionary workbook:
d <- try(morie_arsau_read_xlsx_dictionary("arsau_dictionary.xlsx"))
#> Error : XLSX data-dictionary not found at arsau_dictionary.xlsx
# }