Skip to contents

Fetches and displays metadata for any study available in the clinTrialData library – without downloading the full dataset. Metadata includes the study description, available domains and datasets, subject count, version, and data source attribution.

For studies already downloaded via download_study(), the metadata is read from the local cache and works offline. For studies not yet downloaded, a small JSON file (~2KB) is fetched from the GitHub Release.

Usage

dataset_info(source, repo = "Lovemore-Gakava/clinTrialData")

Arguments

source

Character string. Name of the study (e.g. "cdisc_pilot_extended"). Use list_available_studies() to see all options.

repo

GitHub repository in the form "owner/repo". Defaults to the official clinTrialData release repository.

Value

Invisibly returns the metadata as a named list.

Examples

# \donttest{
dataset_info("cdisc_pilot")
#> ──────────────────────────────────────────────────────────────────────
#> cdisc_pilot (v0.1.0)
#> ──────────────────────────────────────────────────────────────────────
#> CDISC Pilot 01 Study — standard ADaM and SDTM datasets widely used for training and prototyping
#> 
#> Domains & datasets:
#>   adam   (11): adae, adlb, adlbc, adlbh, adlbhy, adqsadas, adqscibc, adqsnpix, ... (11 total)
#>   sdtm   (22): ae, cm, dm, ds, ex, lb, mh, qs, ... (22 total)
#> 
#> Subjects:   225
#> Version:    v0.1.0
#> License:    CDISC Pilot — educational use
#> Source:     https://github.com/cdisc-org/sdtm-adam-pilot-project
#> ──────────────────────────────────────────────────────────────────────
# }