ExportTable: ExportTable

In legenepi/exceed-pipelines: Reusable pipelines for the EXCEED study

ExportTable

Description

ExportTable class

Format

An R6 class object.

Details

Generic export of a single table.

Super classes

exceedapi::SnapshotBackend -> exceedapi::API -> exceedapi::Step -> ExportTable

Methods

Public methods

• ExportTable$get_fields()

• ExportTable$alert_warning()

• ExportTable$alert_danger()

• ExportTable$check_study_id_range()

• ExportTable$add_shared_metadata()

• ExportTable$add_prefix()

• ExportTable$get_field_type_overrides()

• ExportTable$verify_table()

• ExportTable$write_metadata()

• ExportTable$write_dataset()

• ExportTable$write_table()

• ExportTable$clone()

Inherited methods

• exceedapi::Step$add_step()

• exceedapi::Step$add_step_object()

• exceedapi::Step$initialize()

• exceedapi::Step$inverse_transform()

• exceedapi::Step$progress_bar()

• exceedapi::Step$run()

• exceedapi::Step$transform()

---

Method get_fields()

Usage

ExportTable$get_fields(exclude = FALSE)

---

Method alert_warning()

Usage

ExportTable$alert_warning(message, success, ...)

---

Method alert_danger()

Usage

ExportTable$alert_danger(message, success, ...)

---

Method check_study_id_range()

Usage

ExportTable$check_study_id_range(study_id)

---

Method add_shared_metadata()

Usage

ExportTable$add_shared_metadata(metadata)

---

Method add_prefix()

Usage

ExportTable$add_prefix(dataset)

---

Method get_field_type_overrides()

Usage

ExportTable$get_field_type_overrides(name, type)

---

Method verify_table()

Usage

ExportTable$verify_table(metadata, dataset)

---

Method write_metadata()

Usage

ExportTable$write_metadata(metadata, ...)

---

Method write_dataset()

Usage

ExportTable$write_dataset(dataset, ...)

---

Method write_table()

Usage

ExportTable$write_table(metadata, dataset)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ExportTable$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

legenepi/exceed-pipelines documentation built on Oct. 22, 2024, 7:48 p.m.