Function reference • teal.data

Delayed Dataset Constructors

For creating delayed dataset objects.

cdisc_dataset(): Create a new object of CDISCTealDataset class

cdisc_dataset_file(): Load CDISCTealDataset object from a file

dataset(): S3 method to construct an MAETealDataset object from MultiAssayExperiment

dataset_file(): Load TealDataset object from a file

mae_dataset(): The constructor of MAETealDataset

Delayed Dataset Connectors Constructors

For creating delayed dataset connector objects.

cdisc_data_connector(): The constructor of CDISCTealDataConnector objects.

cdisc_dataset_connector(): Create a new CDISCTealDatasetConnector object

dataset_connector_file() cdisc_dataset_connector_file(): Load TealDatasetConnector object from a file

code_dataset_connector() code_cdisc_dataset_connector(): Code TealDatasetConnector

csv_dataset_connector() csv_cdisc_dataset_connector(): csv TealDatasetConnector

data_connection(): The constructor for TealDataConnection class.

dataset_connector(): Create a new TealDatasetConnector object

fun_dataset_connector() fun_cdisc_dataset_connector(): Function Dataset Connector

python_dataset_connector() python_cdisc_dataset_connector(): Python TealDatasetConnector

rds_dataset_connector() rds_cdisc_dataset_connector(): RDS TealDatasetConnector

relational_data_connector(): The constructor for TealDataConnector class.

script_dataset_connector() script_cdisc_dataset_connector(): Script TealDatasetConnector

Delayed Data Constructors

For creating delayed data objects.

cdisc_data(): Data input for teal app

cdisc_data_file(): Load TealData object from a file

teal_data(): Teal data

teal_data_file(): Load TealData object from a file

to_relational_data(): S3 generic for to_relational_data function.

Delayed Dataset Functions

For loading and modifying delayed data objects.

as_cdisc(): Convert a TealDataset(Connector) object to a CDISCTealDataset(Connector) object

callable_code(): Create CallableCode object

callable_function(): Create CallableFunction object

get_attrs(): Get dataset attributes

get_cdisc_keys(): Function that returns the default keys for a CDISC dataset by name

get_code(): Get code

get_dataname(): S3 method for getting a dataname(s) of (TealDataAbstract, (TealDatasetConnector or TealDataset) R6 object

get_dataset(): Get dataset from TealDatasetConnector

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

get_datasets(): Get a TealDataset objects.

get_keys(): Get dataset primary keys

get_raw_data(): Retrieve raw data

is_pulled(): Is pulled

load_dataset(): Load data from connection

load_datasets(): Load datasets

mutate_data(): Mutate data by code

mutate_dataset(): Mutate dataset by code

mutate_join_keys(): Mutate JoinKeys with a new values

set_args(): Set arguments of a CallableFunction

set_keys(): Set dataset primary keys

Helpers

Other useful functions for users and developers.

col_labels(): Get Label Attributes of Variables in a data.frame

`col_labels<-`(): Set Label Attributes of All Variables in a data.frame

col_relabel(): Copy and Change Variable Labels of a data.frame

data_label(): Get dataset label attribute

`data_label<-`(): Set dataset label attribute

example_cdisc_data(): This function returns a dummy dataset for testing examples and should only be used within teal.data.

get_key_duplicates(): S3 generic for creating an information summary about the duplicate key values in a dataset

get_labels(): Extracts dataset and variable labels from a dataset.

join_key(): Create a relationship between a pair of datasets

join_keys(): Create a JoinKeys out of a list of JoinKeySet objects

python_code(): Python Code

read_script(): Read .R file into character

validate_metadata(): validate metadata as a list of length one atomic entries (or NULL)

For Developers

Abstract and concrete classes used to build teal functionality.

R6 Classes

Abstract and concrete classes used to build teal functionality.

CallableCode: A CallableCode class of objects

CallablePythonCode: A CallablePythonCode class of objects

CDISCTealDataConnector: Manage multiple and TealDatasetConnector of the same type.

CDISCTealDataset: R6 Class representing a dataset with parent attribute

CDISCTealDatasetConnector: A CDISCTealDatasetConnector class of objects

JoinKeys: R6 Class to store relationships for joining datasets

MAETealDataset: R6 Class representing a MultiAssayExperiment object with its attributes

PythonCodeClass: A CallablePythonCode class of objects

TealData: Manage multiple TealDataConnector, TealDatasetConnector and TealDataset objects.

TealDataConnection: A TealDataConnection class of objects

TealDataConnector: Manage multiple and TealDatasetConnector of the same type.

TealDataset: R6 Class representing a dataset with its attributes

TealDatasetConnector: A TealDatasetConnector class of objects