cdmName {CDMConnector}

R Documentation

Get the CDM name

Description

Extract the CDM name attribute from a cdm_reference object

Usage

cdmName(cdm)

cdm_name(cdm)

Arguments

cdm	A cdm object

Value

The name of the CDM as a character string

Examples

## Not run: 
library(CDMConnector)
con <- DBI::dbConnect(duckdb::duckdb(), eunomia_dir())
cdm <- cdm_from_con(con, "main")
cdmName(cdm)
#> [1] "Synthea synthetic health database"

cdm <- cdm_from_con(con, "main", cdm_name = "Example CDM")
cdmName(cdm)
#> [1] "Example CDM"

DBI::dbDisconnect(con, shutdown = TRUE)

## End(Not run)

---