Learn R Programming

coreval (version 0.4.0)

check_dataset: Check one dataset, without needing a study folder

Description

For when you are writing the code that builds a domain and want to know what is wrong with it right now. Give it the data frame you already have open, or the path to a single file.

Usage

check_dataset(
  x,
  domain = NULL,
  standard = NULL,
  version = NULL,
  use_case = NULL,
  max_records = 1000,
  include_deprecated = FALSE,
  ct_package = NULL,
  substandard = NULL
)

Value

An object of class coreval_result: a list of the three tables findings, skipped and truncated, the same shape check_study()

returns, so write_findings() and filter_findings() work on it unchanged. Because it has a class, typing the result's name prints a readable report rather than dumping the list.

skipped carries a reason for every rule that did not run - a dataset you did not supply, a missing Define-XML, or, for the rules that ask whether a value is an allowed term, CDISC's controlled terminology if you did not say which package the study follows - see ct_package. Nothing skipped is ever counted as a pass.

Provenance rides along as attributes: checks_run (how many rules were evaluated), domains, and excluded_by_standard (how many rules the standard/version filter set aside). write_findings() writes these into the file it saves.

Arguments

x

A data frame (or data.table::data.table()), or the path to one .xpt, .sas7bdat or .csv file. A CSV file records no types, so each column's is guessed: one of plain numbers is read as numeric, and a value with a leading zero such as "007" stays text. An identifier written as a plain number can then be reported as the wrong type; an .xpt file carries the types it was written with.

domain

Two-letter domain code, e.g. "AE". Left as NULL, coreval takes it from your DOMAIN column, or the file name if there isn't one. For one file of a split dataset with no DOMAIN column, such as ae1.xpt, set it yourself.

standard

Required. The standard the data follows, e.g. "SDTMIG", "SENDIG" or "TIG". Only that standard's rules run: a SENDIG rule has nothing to say about an SDTM study. The report says how many rules were set aside.

version

The standard's version, e.g. "3-4". A version older than any the rules are written for is checked against the oldest that has rules, and the report says so.

use_case

Optional use case (e.g. "INDH"), as in list_rules().

max_records

Most records to keep per rule, default 1000. A rule that flags every row of a large dataset would otherwise produce more findings than anyone can read or Excel can hold. The true count is kept in truncated. Use Inf for every record.

include_deprecated

Also run retired rules: those CDISC has deprecated, and, for an SDTM study, CDISC's SDTM rules that CORE 1.0 no longer carries. FALSE by default: a retired rule has a current replacement, so running both can report the same defect twice.

ct_package

Which CDISC Controlled Terminology package the study follows, e.g. "sdtmct-2026-03-27". Rules that ask whether a value is a legal term need this, and are skipped with a reason without it - coreval will not pick a version for you, because terminology changes between releases and judging a study against one it never declared would both invent violations and hide real ones. Every package CDISC's engine carries, from 2014 on, is bundled; list_ct_packages() shows them.

substandard

For standard = "TIG" only, and required there: whether the tobacco study is "SDTM" (clinical), "SEND" (nonclinical) or "ADaM". A TIG rule's use case covers different datasets in each, so CDISC's engine will not check a TIG study without it, and neither will coreval.

What it cannot check on its own

Plenty of CDISC rules compare one dataset against another - an adverse event date against the subject's reference dates in DM, a visit against the trial design. Hand over a single dataset and those questions cannot be answered.

coreval does not guess. Those rules are skipped, and $skipped names the dataset each one wanted. Running them anyway would compare your data against columns that are not there and report problems that do not exist.

Most rules still run on a single dataset. But the ones that cannot are the cross-dataset checks, which are often the ones that matter.

So a short $findings table here does not mean the data is clean. It is a quick first pass, not a verdict. Run check_study() on the whole folder before drawing conclusions.

See Also

check_study() to check a whole study folder.

Examples

Run this code
ae <- data.frame(
  STUDYID = "S1", DOMAIN = "AE", USUBJID = c("01", "01"),
  AESEQ = c(1, 2), AETERM = c("Headache", "Rash"),
  AESTDTC = c("2024-01-10", "2024-02-30") # 30 February is not a date
)
result <- check_dataset(ae, standard = "SDTMIG")
result$findings[result$findings$Value == "2024-02-30", ]

# Always look at what could not run:
nrow(result$skipped)

Run the code above in your browser using DataLab