Skip to contents

Register custom controlled terminology

Source: R/rule-fetch.R
register_ct.Rd

Loads a controlled terminology file and registers it for the current R session. Subsequent calls to validate() and submit() automatically merge the custom CT on top of the bundled CDISC CT. Custom terms for a given codelist code take precedence; CDISC terms fill any gaps.

The file must follow the NCI EVS column layout (same format as files downloaded from the NCI EVS browser or the CDISC Library):

  • Codelist Code — NCI concept code, e.g. C66731

  • Codelist Name — human-readable codelist name

  • CDISC Submission Value — submission term used in data

  • CDISC Definition — term definition

  • Codelist Extensible (Yes/No) — whether custom terms are allowed

Supported file types: .xlsx (Excel), .csv.

Usage

register_ct(name, path)

Arguments

name

Character. A unique identifier for this CT package, e.g. "org-sdtm" or "org-adam".

path

Character. Path to the terminology file (.xlsx or .csv).

Value

Invisible NULL.

See also

clear_ct(), list_ct(), validate()

Other conformance: adam_rules(), build_anchor_index(), clear_ct(), fda_rules(), fetch_core_rules(), fetch_herald_rules(), herald_rules_cache_dir(), list_ct(), load_herald_config(), new_herald_context(), pmda_rules(), register_operator(), rule_catalog(), rule_config(), update_core_rules(), validate(), validate_spec(), validate_spec_define(), validation_report(), verify_html_report()

Examples

if (FALSE) { # \dontrun{
register_ct("org-sdtm", "path/to/Custom_SDTM_Terminology.xlsx")
register_ct("org-adam", "path/to/Custom_ADaM_Terminology.xlsx")
list_ct()
} # }