ruminate (version 0.3.1)

NCA_fetch_ds: Fetch Module Datasets

Description

Fetches the datasets contained in the module

Usage

NCA_fetch_ds(state)

Value

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

  • DS: Dataframe containing the actual dataset.

  • DSMETA: Metadata describing DS

  • code: Complete code to build dataset.

  • checksum: Module checksum.

  • DSchecksum: Dataset checksum.

Arguments

state

NCA state from NCA_fetch_state()

Examples

# We need a state object to use below
sess_res = NCA_test_mksession()
state = sess_res$state

myDs = NCA_fetch_ds(state)