check_ard_structure: Check ARD Structure

In cards: Analysis Results Data

Check ARD Structure

Description

Function tests the structure and returns notes when object does not conform to expected structure.

Usage

check_ard_structure(
  x,
  column_order = TRUE,
  method = TRUE,
  error_on_fail = FALSE
)

Arguments

x	(data.frame) an ARD data frame of class 'card'
column_order	(scalar logical) check whether ordering of columns adheres to to cards::tidy_ard_column_order().
method	(scalar logical) check whether a "stat_name" equal to "method" appears in results.
error_on_fail	(scalar logical) Error if a check is failed? FALSE by default.

Value

an ARD data frame of class 'card' (invisible)

Examples

ard_summary(ADSL, variables = "AGE") |>
  dplyr::select(-warning, -error) |>
  check_ard_structure()

cards documentation built on Aug. 21, 2026, 5:09 p.m.