startEpiviz: Start epiviz app and create 'EpivizApp' object to manage...

Description Usage Arguments Value Examples

View source: R/startEpiviz.R

Description

Start epiviz app and create EpivizApp object to manage connection.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
startEpiviz(
  host = NULL,
  http_port = NULL,
  path = NULL,
  use_devel = FALSE,
  chr = "chr11",
  start = 99800000,
  end = 103383180,
  debug = FALSE,
  workspace = NULL,
  scripts = NULL,
  gists = NULL,
  use_cookie = TRUE,
  register_function = .register_all_the_epiviz_things,
  open_browser = TRUE,
  server = NULL,
  browser_fun = utils::browseURL,
  ws_host = "localhost",
  ...
)

Arguments

host

(character) use a host for the epiviz app other than the cbcb.umd.edu hosts.

http_port

(integer) port at host serving the epiviz app.

path

(character) path at host where epiviz app is located.

use_devel

(logical) use the devel epiviz application server (http://epiviz-dev.cbcb.umd.edu).

chr

(character) chromosome to browse to on app startup.

start

(integer) start location to browse to on app startup.

end

(integer) end location to browse to on app startup.

debug

(logical) start epiviz app in debug mode.

workspace

(character) a workspace id to load in the epiviz app on startup.

scripts

(character) URLs for JavaScript plugin scripts to be imported when epiviz is loaded (see http://epiviz.cbcb.umd.edu/help for details).

gists

(character) Ids for github gists (http://gist.github.com) containing JavaScript plugin scripts to be imported when epiviz is loaded (see http://epiviz.cbcb.umd.edu/help for details).

use_cookie

(logical) use cookies within the epiviz app.

register_function

(function) function used to register actions and charts on the epiviz app.

open_browser

(logical) browse to the epiviz URL before exiting function.

server

(EpivizServer) if not NULL use this object as underlying WebSocket and HTTP server

browser_fun

(function) function used to browse to URL (browseURL by default)

ws_host

(character) host address to use for websocket connection ("localhost" by default)

...

additional parameters passed to createServer.

Value

An object of class EpivizApp

Examples

1
2
3
# see package vignete for example usage
app <- startEpiviz(non_interactive=TRUE, open_browser=TRUE)
app$stop_app()

epivizr documentation built on April 29, 2020, 3:33 a.m.