shinyTANDEM: Launch a shiny GUI for rTANDEM

Description Usage Arguments Value Author(s) Examples

View source: R/shinyTANDEM.R

Description

The function shinyTANDEM(dataset, port) launch a shiny GUI running on the given port. The shiny GUI will use the default browser. A rTANDEM result object can be passed as an argument. In this case, the dataset will be loaded as the GUI opens. The dataset can be changed later on by loading another dataset either from an xml or an Rdata file. If a dataset is loaded from an Rda file that contains more than one object, the name of the object to be loaded must be specified.

Usage

1
shinyTANDEM(dataset=NULL, port=8100,...)

Arguments

dataset

An optional rTANDEM result object (class rTResult) that will be loaded as the GUI opens.

port

Shiny's default port is 8100. The port parameter lets you specify a different one.

...

Arguments can be passed to shiny::runApp().

Value

This function does not return. Interrupt R to stop the GUI (usually by pressing Ctrl+C or Esc).

Author(s)

Authors: Frederic Fournier <frederic.fournier@crchuq.ulaval.ca>, Arnaud Droit <arnaud.droit@crchuq.ulaval.ca> Maintainer: Frederic Fournier <frederic.fournier@crchuq.ulaval.ca>

Examples

1
2
3
4
5
6
7
8
 
# The package contains a RDS file with a rTResult object. Load it into 
# memory and pass it to the call to shinyTANDEM.
# To exit the GUI, press your interupt command
# (usually Ctrl+C or Esc) in the R window.

my.result <- readRDS(system.file("extdata/result.RDS", package="shinyTANDEM"))
if(interactive()){ shinyTANDEM(dataset=my.result) }

shinyTANDEM documentation built on Nov. 8, 2020, 8:20 p.m.