Skip to contents

Run the Shiny Application

Usage

run_app(
  onStart = NULL,
  options = list(),
  enableBookmarking = "url",
  uiPattern = "/",
  studies = NULL,
  cache_path = NULL,
  log_path = "log",
  authr_file = NULL,
  ...
)

Arguments

onStart

A function that will be called before the app is actually run. This is only needed for shinyAppObj, since in the shinyAppDir case, a global.R file can be used for this purpose.

options

Named options that should be passed to the runApp call (these can be any of the following: "port", "launch.browser", "host", "quiet", "display.mode" and "test.mode"). You can also specify width and height parameters which provide a hint to the embedding environment about the ideal height/width for the app.

enableBookmarking

Can be one of "url", "server", or "disable". The default value, NULL, will respect the setting from any previous calls to enableBookmarking(). See enableBookmarking() for more information on bookmarking your app.

uiPattern

A regular expression that will be applied to each GET request to determine whether the ui should be used to handle the request. Note that the entire request path must match the regular expression in order for the match to be considered successful.

studies

a file path to a summary of all available studies. The file should be a tab separated table, with the headers: title output rds description doi date nsamples nfeatures ncells. By default the file read contains information about a very small subset of pbmc3k present in the package. Check out vignette("database", package = "singlecellviz") for more information.

cache_path

a path to the cache directory to use. If the folder already exists, make sure that the use has read and write access.

log_path

a path to the log directory, where a telemetry.txt file will be created. If the folder or file already exists, make sure that the use has read and write access.

authr_file

a path to the authr .txt file, where the columns user, password_hash, and permissions are available. If the folder or file already exists, make sure that the use has read and write access.

...

arguments to pass to golem_opts. See `?golem::get_golem_options` for more details.