formods (version 0.2.1)

DW_fetch_ds: Fetch Module Datasets

Description

Fetches the datasets contained in the module.

Usage

DW_fetch_ds(state)

Value

Character object vector with the lines of code

list containing the following elements

• isgood: Return status of the function.

• hasds: Boolean indicator if the module has any datasets

• msgs: Messages to be passed back to the user.

• ds: List with datasets. Each list element has the name of the R-object for that dataset. Each element has the following structure:

  • label: Text label for the dataset

  • MOD_TYPE: Short name for the type of module.

  • id: module ID

  • idx: unique numerical ID to identify this dataset in the module.

  • DS: Dataframe containing the actual dataset.

  • DSMETA: Metadata describing DS, see FM_fetch_ds() for details on the format.

  • code: Complete code to build dataset.

  • checksum: Module checksum.

  • DSchecksum: Dataset checksum.

Arguments

state

UD state from UD_fetch_state()

Examples

# We need a state variable
sess_res = DW_test_mksession()
state = sess_res$state

ds = DW_fetch_ds(state)