Skip to contents

S3 method for getting a label of (TealDatasetConnector or TealDataset) R6 object

get_dataset_label.Rd

[Stable]

Usage

get_dataset_label(x)

# S3 method for TealDatasetConnector
get_dataset_label(x)

# S3 method for TealDataset
get_dataset_label(x)

Arguments

x

(TealDatasetConnector or TealDataset) R6 object

Value

label (character) Label to describe the dataset

Examples

fun <- callable_function(data.frame)
fun$set_args(list(c1 = seq_len(10)))

x <- dataset_connector(
  pull_callable = fun,
  dataname = "ADSL",
  label = "My custom label"
)
get_dataset_label(x)
#> [1] "My custom label"
library(scda)
ADSL <- synthetic_cdisc_data("latest")$adsl
ADSL_dataset <- dataset(dataname = "ADSL", x = ADSL, label = "My custom label")
get_dataset_label(ADSL_dataset)
#> [1] "My custom label"