launchCerebroV1.3: Launch Cerebro v1.3

Description Usage Arguments Value Examples

View source: R/launchCerebroV1.3.R

Description

Launch the Cerebro v1.3 Shiny application.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
launchCerebroV1.3(
  mode = "open",
  maxFileSize = 800,
  crb_file_to_load = NULL,
  welcome_message = NULL,
  projections_default_point_size = 5,
  projections_default_point_opacity = 1,
  projections_default_percentage_cells_to_show = 100,
  projections_show_hover_info = TRUE,
  ...
)

Arguments

mode

Cerebro can be ran in open or closed mode, allowing the user to load their own data set (open) or only show a pre-loaded data set (closed, removes the "Load data" element); defaults to open.

maxFileSize

Maximum size of input file; defaults to 800 (800 MB).

crb_file_to_load

Path to .crb file to load on launch of Cerebro. Useful when using/hosting Cerebro in closed mode. Defaults to NULL.

welcome_message

string with custom welcome message to display in the "Load data" tab. Can contain HTML formatting, e.g. '<h3>Hi!</h3>'. Defaults to NULL.

projections_default_point_size

Default point size in projections. This value can be changed in the UI; defaults to 5.

projections_default_point_opacity

Default point opacity in projections. This value can be changed in the UI; defaults to 1.0.

projections_default_percentage_cells_to_show

Default percentage of cells to show in projections. This value can be changed in the UI; defaults to 100.

projections_show_hover_info

Show hover infos in projections. This

...

Further parameters that are used by shiny::runApp, e.g. host or port.

Value

Shiny application.

Examples

1
2
3
4
5
6
if ( interactive() ) {
  launchCerebroV1.3(
    mode = "open",
    maxFileSize = 800
  )
}

romanhaa/cerebroApp documentation built on Nov. 25, 2021, 5:29 p.m.