iso_start_viewer: Start isoviewer GUI

Description Usage Arguments Details

View source: R/run.R

Description

Provides a graphical user interface to explore continuous flow, dual inlet and scan isofile objects. Note that while the GUI is running, your R session will be blocked. To stop the GUI and return to your R session, either click the Close button inside the GUI navigation bar (if running it in non-server mode) or press Esc in your R session.

Usage

1
2
3
4
5
6
7
iso_start_viewer(iso_objects = iso_find_objects(), log = FALSE, reset = FALSE)

iso_start_viewer_server(
  iso_objects = iso_find_objects(),
  launch = TRUE,
  log = TRUE
)

Arguments

iso_objects

which iso objects to make accessible in the GUI. By default searches through the current workspace and makes all iso objects it can find available. If a single variable is provided (rather than a named list), launches the GUI only for that variable (no others are accessible).

log

whether to show log info messages or not. By default, shows logs when running in server mode (iso_start_viewer_server) and does not show them otherwise.

reset

whether to reset the viewer settings and memory back to their defaults. Usually only necessary if your viewer crashed unexpectedly and gets stuck during restart. Please consider reporting the details of the crash at https://github.com/isoverse/isoviewer/issues, especially if you can easily reproduce it.

launch

whether to launch the shiny server immediately (if starting the server from a local R instance) or only on request (if running on a server such as shinyApps.io).

Details

iso_start_viewer starts a simple personal GUI that is only accessible on the computer it is running on.

iso_start_viewer_server starts a server for GUI. If running it from an R session on a normal computer, it will be available in the local network at the computer's IP address, port 3838. For example, if you run it on your computer and your IP address is 192.168.0.42, other computers on your network can launch your GUI by pointing a browser at http://192.168.0.4:3838 (note that if your firewall or local network blocks port 3838, this will not be possible). If running on a shinyapps server such as shinyapps.io instead, you have to set launch = FALSE because the shinyapps server takes care of launching the app on demand.


KopfLab/isoviewer documentation built on July 16, 2021, 1:21 a.m.