Learn R Programming

clinCompare (version 1.0.0)

get_adam_metadata: ADaM Metadata

Description

Returns metadata for ADaM datasets following CDISC standards. Provides information about required, conditional, and other variables for each ADaM analysis dataset.

Usage

get_adam_metadata(version = "1.3")

Value

A named list where keys are ADaM dataset names and values are data.frames with columns:

variable

Variable name (character)

label

Variable label/description (character)

type

Data type: "Char" for character or "Num" for numeric

core

Importance level: "Req" (Required), "Cond" (Conditional)

Arguments

version

Character string specifying the ADaM IG version. Supported values: "1.3" (default), "1.2", "1.1".

Note: All versions currently return identical variable definitions. The ADaM IG revisions (1.1 -> 1.3) changed guidance and rules but not the core variable inventory. The parameter exists for provenance tracking only -- it does not enable version-specific validation.

Details

Variable definitions are based on the published CDISC ADaM Implementation Guide. The canonical machine-readable source is the CDISC Library API (https://www.cdisc.org/cdisc-library), which requires CDISC membership. The metadata shipped with clinCompare is hand-curated from the published IG specifications.