run_app: Run the Shiny Application

In pannotator: Visualisation and Annotation of 360 Degree Imagery

Run the Shiny Application

Description

'run_app()' starts the Shiny application contained in this package, with an option to load settings from a YAML file using additional option: projectSettingsFile = "pathToYamlFile".

Usage

run_app(
  onStart = NULL,
  options = list(),
  enableBookmarking = NULL,
  uiPattern = "/",
  ...
)

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.
...	Additional arguments to pass to 'golem_opts'. See '?golem::get_golem_options' for more details.

Details

This function initializes and runs the Shiny app developed with the golem framework. It optionally loads application-specific settings from a YAML file, which can be useful for project-specific configurations.

Value

No return value, called for side effects. Launches the Shiny app.

Examples

if (interactive()) {
  # Example: Run the application with default settings
  run_app()

  # Example: Run the application with a specific YAML configuration file
  run_app(projectSettingsFile = "C:/test-project.yml")
}

pannotator documentation built on April 3, 2025, 7:50 p.m.