ModuleEnvir: R6 'RAVE' Module Class

In beauchamplab/rave: R Analysis and Visualization of 'ECOG/iEEG' Data

R6 'RAVE' Module Class

Description

contains module data, functions, etc.

Public fields

cache_env

cache environment for module

module_id

module ID, unique

label_name

corresponding module name

script_path

compiled module scripts

script

if script_path not exists, alternative script

author

who wrote the module not often used

version

module version

packages

the packages to be loaded for the module

rmd_path

deprecated

parent_env

parent environment of the module, usually global environment or package environment

from_package

whether the module is compiled from another R package. This value is required to be true since "rave-0.1.9".

package_name

which package does the module belong to?

sidebar_width

input panel width, from 1 to 11

Methods

Public methods

• ModuleEnvir$info()

• ModuleEnvir$print()

• ModuleEnvir$new()

• ModuleEnvir$get_or_new_exec_env()

• ModuleEnvir$load_script()

• ModuleEnvir$render_ui()

• ModuleEnvir$clean()

---

Method info()

print module information

Usage

ModuleEnvir$info()

Returns

none

---

Method print()

print module information and returns memory address

Usage

ModuleEnvir$print(...)

Arguments

...

ignored

---

Method new()

constructor

Usage

ModuleEnvir$new(
  module_id,
  label_name,
  script_path,
  author = NULL,
  version = "0",
  packages = NULL,
  .script_content = NULL,
  rmd_path = NULL,
  parent_env = globalenv()
)

Arguments

module_id, label_name, script_path, author, version

see fields

packages, parent_env, rmd_path

see fields

.script_content

internal use

---

Method get_or_new_exec_env()

get the corresponding ExecEnvir with shiny session

Usage

ModuleEnvir$get_or_new_exec_env(
  session = getDefaultReactiveDomain(),
  ...,
  new = FALSE
)

Arguments

session

shiny session; see shiny domains

...

ignored

new

whether to force creating a new runtime environment if previous one already exists

Returns

an ExecEnvir instance associated with current module and given session

---

Method load_script()

load and compile script into registered ExecEnvir

Usage

ModuleEnvir$load_script(session = getDefaultReactiveDomain())

Arguments

session

shiny session; see shiny domains

Returns

none

---

Method render_ui()

generate 'HTML' tags

Usage

ModuleEnvir$render_ui(session = getDefaultReactiveDomain())

Arguments

session

shiny session; see shiny domains

Returns

'HTML' tags

---

Method clean()

clean the module environment

Usage

ModuleEnvir$clean(session = getDefaultReactiveDomain(), session_id)

Arguments

session

shiny session; see shiny domains

session_id

shiny 'RAVE' ID, default is auto-generated

Examples

## Not run: 

module <- get_module('ravebuiltins', 'power_explorer')
module
#> Module Name: Power Explorer 
#> Version: 0 
#> Script Path: ... 
#> Author(s):


## End(Not run)

beauchamplab/rave documentation built on Feb. 23, 2024, 7:20 a.m.