Dataset-JSON header metadata — dataset_json

Reads only the header of a CDISC Dataset-JSON file (version 1.1 or the nested 1.0 layout) and returns the metadata needed to inspect a delivery without materialising the rows: schema version, record count, dataset name/label, provenance fields (`fileOID`, `originator`, `sourceSystem`, `studyOID`), and the `columns` table (itemOID, name, label, dataType, targetDataType, length).

Usage

dataset_json_meta(path)

Arguments

path: Path to a Dataset-JSON file.

Value

A list with elements `path`, `datasetJSONVersion`, `records`, `name`, `label`, `itemGroupOID`, `fileOID`, `originator`, `sourceSystem`, `studyOID`, and `columns` (data.frame). Stops with an informative error when required keys are absent.

Details

Dataset-JSON header metadata

Examples

doc <- list(
  datasetJSONVersion = "1.1",
  datasetJSONCreationDateTime = "2026-01-01T00:00:00",
  columns = list(list(name = "STUDYID", dataType = "string", length = 6)),
  rows = list(list("STUDY01"))
)
f <- file.path(tempdir(), "dm.json")
writeLines(jsonlite::toJSON(doc, auto_unbox = TRUE, null = "null"), f)
meta <- dataset_json_meta(f)
meta$datasetJSONVersion
#> [1] "1.1"
meta$columns
#>   itemOID    name label dataType targetDataType length
#> 1    <NA> STUDYID  <NA>   string           <NA>      6