Skip to contents

Test for a artoo_spec object

Source: R/spec_construct.R
is_artoo_spec.Rd

Report whether an object is a artoo_spec — the validated CDISC specification that drives the artoo workflow (spec -> apply_spec -> read_/write_). artoo_spec() builds one; this is the type guard before you pass it to apply_spec() or reach into it with the spec accessors.

Usage

is_artoo_spec(x)

Arguments

x

Object to test. <any>.

Value

A <logical(1)>: TRUE when x is a artoo_spec, else FALSE.

See also

artoo_spec() to build one; is_artoo_meta() for the metadata guard.

Examples

# ---- Example 1: guard a built specification ----
#
# artoo_spec() assembles and validates a spec; is_artoo_spec() confirms the
# type before you drive apply_spec() with it.
spec <- artoo_spec(cdisc_sdtm_datasets, cdisc_sdtm_variables, codelists = cdisc_codelists)
is_artoo_spec(spec)
#> [1] TRUE

# ---- Example 2: an ordinary object is not a spec ----
#
# Any non-artoo_spec value — a bare data frame, say — returns FALSE.
is_artoo_spec(cdisc_dm)
#> [1] FALSE