Builds a survey-configuration patch that can be passed to [get_pumf()] (or [pumf_metadata()]) via the `registry` argument to drive parsing and building for a survey that is not in the built-in registry, or to override specific fields of one that is.
Usage
pumf_registry_entry(
layout_mask = NULL,
bsw_mask = NULL,
bsw_file_mask = NULL,
bsw_join_key = NULL,
bsw_drop_cols = NULL,
bsw_strata = NULL,
file_mask = NULL,
data_encoding = NULL,
metadata_encoding = NULL,
data_fixups = NULL,
bundled_eng_sps = NULL,
bundle_source = NULL,
bundle_sps_mask = NULL,
doc_mask = NULL,
download_format = NULL,
borealis = NULL,
...
)Arguments
- layout_mask
SPSS/SAS command-file disambiguator for split-file surveys; also becomes part of the DuckDB table name when set.
- bsw_mask, bsw_file_mask, bsw_join_key, bsw_drop_cols, bsw_strata
Bootstrap weight join configuration.
- file_mask
Regex selecting the data file (its extension also decides CSV vs fixed-width).
- data_encoding, metadata_encoding
Encoding overrides (default `"CP1252"` in the pipeline).
- data_fixups
A named list of pre-label fixups: any of `str_pad`, `rename`, `rename_regex`, `cols_swap`, `na_values`, `force_numeric`, `force_character`, `force_integer`, `force_bigint`, `codes_supplement`, `missing_supplement`, `missing_codes`, `labels_supplement`. The `force_character`/`force_integer`/`force_bigint` fields take character vectors of variable names and override the DuckDB storage type (VARCHAR / INTEGER / BIGINT) so geographic codes keep leading zeros and large IDs are not lost; a variable may appear in at most one `force_*` set. `rename_regex` takes `c(pattern = "replacement")` and rewrites many column names at once ([base::sub()] semantics), for releases whose data file decorates the documented names wholesale; a rewrite is applied only where it lands on a name the metadata declares and the current name is not itself declared, so it can never collide with a correctly-named column. `missing_codes` takes `list(VAR = c(codes))` and blanks those discrete values, for variables whose sentinels do not form one contiguous range (and which a single `missing_low`/`missing_high` pair therefore cannot express).
- bundled_eng_sps, bundle_source, bundle_sps_mask, doc_mask
Advanced bundled-archive and documentation options.
- download_format
Format bundle to download when Statistics Canada offers the same edition in several (`"CSV"`, `"SAS"`, `"TXT"`, ...). By default the preferred format wins; set this when only one bundle carries the command files the metadata parsers need (e.g. the Canadian Health Survey on Seniors, whose CSV zip ships the data alone).
- borealis
A Borealis Dataverse source for the data: a DOI string (`"doi:10.5683/SP3/XXXXXX"`) or `list(doi = , files = )`, where the optional `files` (file ids or names from [list_borealis_pumf_files()]) overrides canpumf's automatic choice of data and command files. A registry `borealis` source is used only when Statistics Canada has no download for the version; pass `get_pumf(..., borealis =)` to force it.
- ...
Reserved; passing any unrecognised field name raises an error.
Details
Only the arguments you actually supply are recorded; unspecified fields fall back to the built-in entry (when overriding a known survey) or to the pipeline defaults (for a new survey). This makes the result a *patch* rather than a full replacement. Use [pumf_registry()] to inspect an existing entry as a starting template.
The custom registry covers parsing and building configuration, plus an optional Borealis source (`borealis`); it does not provide a StatCan download URL. For a survey not in [list_canpumf_collection()], either point `borealis` at the dataset on Borealis, or deposit the raw zip (or extracted files) under `<cache_path>/<series>/<version>/` first, then call `get_pumf(series, version, registry = ...)`.