ruminate (version 0.3.1)

CTS_fetch_state: Fetch Clinical Trial Simulator State

Description

Merges default app options with the changes made in the UI

Usage

CTS_fetch_state(
  id,
  id_ASM,
  id_MB,
  input,
  session,
  FM_yaml_file,
  MOD_yaml_file,
  react_state
)

Value

list containing the current state of the app including default values from the yaml file as well as any changes made by the user. The list has the following structure:

• yaml: Full contents of the supplied yaml file.

• MC: Module components of the yaml file.

• CTS:

  • isgood: Boolean object indicating if the file was successfully loaded.

  • checksum: This is an MD5 sum of the contents element and can be used to detect changes in the state.

• MOD_TYPE: Character data containing the type of module "CTS"

• id: Character data containing the module id module in the session variable.

• FM_yaml_file: App configuration file with FM as main section.

• MOD_yaml_file: Module configuration file with MC as main section.

Arguments

id

Shiny module ID

id_ASM

ID string for the app state management module used to save and load app states

id_MB

An ID string that corresponds with the ID used to call the MB modules

input

Shiny input variable

session

Shiny session variable

FM_yaml_file

App configuration file with FM as main section.

MOD_yaml_file

Module configuration file with MC as main section.

react_state

Variable passed to server to allow reaction outside of module (NULL)

Examples

# Within shiny both session and input variables will exist,
# this creates examples here for testing purposes:
sess_res = MB_test_mksession()
session = sess_res$session
input   = sess_res$input

# Configuration files
FM_yaml_file  = system.file(package = "formods", "templates", "formods.yaml")
MOD_yaml_file = system.file(package = "ruminate", "templates", "CTS.yaml")

# Creating an empty state object
state = CTS_fetch_state(id              = "CTS",
                       id_ASM          = "ASM",
                       id_MB           = "MB",
                       input           = input,
                       session         = session,
                       FM_yaml_file    = FM_yaml_file,
                       MOD_yaml_file   = MOD_yaml_file,
                       react_state     = NULL)