GenericExport: GenericExport

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

GenericExport

Description

GenericExport class

Format

An R6 class object.

Details

Generic export class that includes password-protected compression (optional)

Super classes

exceedapi::SnapshotBackend -> exceedapi::API -> exceedapi::Step -> GenericExport

Methods

Public methods

• GenericExport$new()

• GenericExport$get_config()

• GenericExport$show_config()

• GenericExport$show_summary()

• GenericExport$get_version()

• GenericExport$get_source_path()

• GenericExport$generate_password()

• GenericExport$prepare_export()

• GenericExport$export_tables()

• GenericExport$create_encrypted_archive()

• GenericExport$create_unencrypted_archive()

• GenericExport$calulate_checksums()

• GenericExport$make_filename()

• GenericExport$write_csv()

• GenericExport$write_lines()

• GenericExport$create_archive()

• GenericExport$create_manifest()

• GenericExport$create_manifest_csv()

• GenericExport$create_manifest_pdf()

• GenericExport$create_codebook()

• GenericExport$create_report()

• GenericExport$render_markdown()

• GenericExport$clone()

Inherited methods

• exceedapi::Step$add_step()

• exceedapi::Step$add_step_object()

• exceedapi::Step$inverse_transform()

• exceedapi::Step$progress_bar()

• exceedapi::Step$run()

• exceedapi::Step$transform()

---

Method new()

Usage

GenericExport$new(...)

---

Method get_config()

Usage

GenericExport$get_config()

---

Method show_config()

Usage

GenericExport$show_config()

---

Method show_summary()

Usage

GenericExport$show_summary()

---

Method get_version()

Usage

GenericExport$get_version()

---

Method get_source_path()

Usage

GenericExport$get_source_path()

---

Method generate_password()

Usage

GenericExport$generate_password(length = NULL)

---

Method prepare_export()

Usage

GenericExport$prepare_export(domain)

---

Method export_tables()

Usage

GenericExport$export_tables(tables, identities)

---

Method create_encrypted_archive()

Usage

GenericExport$create_encrypted_archive(archive, files, password)

---

Method create_unencrypted_archive()

Usage

GenericExport$create_unencrypted_archive(archive, files)

---

Method calulate_checksums()

Usage

GenericExport$calulate_checksums(file)

---

Method make_filename()

Usage

GenericExport$make_filename(name, suffix)

---

Method write_csv()

Usage

GenericExport$write_csv(x, file, ...)

---

Method write_lines()

Usage

GenericExport$write_lines(x, file, ...)

---

Method create_archive()

Usage

GenericExport$create_archive(tables)

---

Method create_manifest()

Usage

GenericExport$create_manifest(tables, template)

---

Method create_manifest_csv()

Usage

GenericExport$create_manifest_csv(tables)

---

Method create_manifest_pdf()

Usage

GenericExport$create_manifest_pdf(tables, template)

---

Method create_codebook()

Usage

GenericExport$create_codebook(tables, template)

---

Method create_report()

Usage

GenericExport$create_report(tables, template)

---

Method render_markdown()

Usage

GenericExport$render_markdown(input, output_file, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GenericExport$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

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