ReadableJsonOptions: Read-only R6 Class defining options available to config...

In xaviermiles/portalLite: Generic shiny app configurable through JSON files.

Description

All options must be set during initialisation, as there are no functions to set/add afterwards.

Each of these generic functions/R6Classes can internally accept/access more specific config options.

Methods

Public methods

• ReadableJsonOptions$new()

• ReadableJsonOptions$print()

• ReadableJsonOptions$get_data_service_functions()

• ReadableJsonOptions$get_data_service_function()

• ReadableJsonOptions$get_data_types()

• ReadableJsonOptions$get_data_type()

• ReadableJsonOptions$get_load_functions()

• ReadableJsonOptions$get_load_function()

• ReadableJsonOptions$get_plot_functions()

• ReadableJsonOptions$get_plot_function()

• ReadableJsonOptions$clone()

---

Method new()

Create a new ReadableJsonOptions object.

Usage

ReadableJsonOptions$new(
  data_service_functions,
  data_types,
  load_functions,
  plot_functions
)

Arguments

data_service_functions

Data service functions to add during initialisation. These functions can be used to fetch data from data services such as REST APIs.

data_types

List of variables which refer to data type R6 classes (to add during initialization). These classes can be used to store datasets in R memory after loading (using a corresponding 'load function').

load_functions

Load functions to add during initialization. These functions can be used to load the datasets from files (or elsewhere) into an appropriate 'data type' instance.

plot_functions

List of plot functions to add during initialisation. These functions can be used to translate one (or more) of the 'data type' classes into a plot to be rendered by shiny.

---

Method print()

Print important contents.

Usage

ReadableJsonOptions$print()

---

Method get_data_service_functions()

Get list of available data service functions.

Usage

ReadableJsonOptions$get_data_service_functions()

---

Method get_data_service_function()

Get specific data service function.

Usage

ReadableJsonOptions$get_data_service_function(name)

Arguments

name

Name of data service function.

---

Method get_data_types()

Get list of available data type R6 classes.

Usage

ReadableJsonOptions$get_data_types()

---

Method get_data_type()

Get specific data type R6Class.

Usage

ReadableJsonOptions$get_data_type(name)

Arguments

name

Name of data type.

---

Method get_load_functions()

Get list of available load functions.

Usage

ReadableJsonOptions$get_load_functions()

---

Method get_load_function()

Get specific load function.

Usage

ReadableJsonOptions$get_load_function(name)

Arguments

name

Name of load function.

---

Method get_plot_functions()

Get list of available plot functions.

Usage

ReadableJsonOptions$get_plot_functions()

---

Method get_plot_function()

Get specific plot function.

Usage

ReadableJsonOptions$get_plot_function(name)

Arguments

name

Name of plot function.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ReadableJsonOptions$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

xaviermiles/portalLite documentation built on Jan. 28, 2022, 9:10 a.m.