Describe a single ARSAU dataset entry.

Usage

morie_arsau_describe(
  kind,
  year,
  language = "en",
  data_dir = NULL,
  n_preview_rows = 3L
)

Arguments

kind: One of ARSAU_KINDS().
year: One of ARSAU_YEARS().
language: "en" or "fr".
data_dir: Optional explicit ARSAU root.
n_preview_rows: Number of rows from the CSV head to include.

Value

An object of class "morie_arsau_result".

Examples

res <- morie_arsau_describe("main_records", "2024")
res$summary_lines
#> $`Year/range`
#> [1] "2024"
#> 
#> $Kind
#> [1] "main_records"
#> 
#> $`CSV filename`
#> [1] "uof_main_records.csv"
#> 
#> $`Sidecar resource_id`
#> [1] "ea9dc29c-b4f1-4426-b1f2-974ce995aca1.json"
#> 
#> $`Expected rows`
#> [1] 10849
#> 
#> $`Expected cols`
#> [1] 65
#> 
#> $Valid
#> [1] "yes"
#> 
#> $`CSV on disk`
#> [1] "no"
#>