RAVEModule: Definition for 'RAVE' module class

In dipterix/rave2:

Description

Definition for 'RAVE' module class

Definition for 'RAVE' module class

Public fields

debug

whether module is in debug mode

package

'RAVE' module's package name

package_env

package name space

package_config

package configuration list

module_id

module ID string

module_label

friendly display name

module_group

module category

package_data

list storing package key-values pairs

containers

stores run-time instances

Active bindings

package_root

package root directory, when running in debug context, returns module debug path, otherwise returns system package path

Methods

Public methods

• RAVEModule$new()

• RAVEModule$add_container()

• RAVEModule$get_path()

---

Method new()

constructor

Usage

RAVEModule$new(package, module_id, force = FALSE, debug = FALSE)

Arguments

package

character package name

module_id

'RAVE' module ID

force

whether to force reload the source script

debug

whether to set in debug mode

---

Method add_container()

Add run-time container instance

Usage

RAVEModule$add_container(session = shiny::getDefaultReactiveDomain())

Arguments

session

shiny session

---

Method get_path()

get script paths

Usage

RAVEModule$get_path(path)

Arguments

path

relative or absolute, behaves slightly different when debugging modules, internally used

dipterix/rave2 documentation built on Sept. 1, 2020, 12:07 a.m.