vdbConn: Connect to a VDB

Description Usage Arguments Details Value Examples

View source: R/conn_vdb.R

Description

Connect to a new or existing visualization database

Usage

1
2
vdbConn(path, name = NULL, autoYes = FALSE, updateFiles = TRUE,
  verbose = TRUE)

Arguments

path

the path on the local file system where the directory for the VDB is located

name

a character string giving the name of the VDB. If the VDB already exists and name = NULL, the previous name is used. If the VDB exists and a string is provided for name, the name is overwritten. The primary purpose of the name argument is to facilitate deploying the trelliscope display as a Shiny app. See the appName argument of deployVDB

autoYes

should questions to proceed with directory creation operations be automatically answered with "yes"?

updateFiles

upon connection, should the Trelliscope viewer app files be updated in the VDB directory?

verbose

should messages be printed about what is being done?

Details

Connecting to a VDB is required prior to calling makeDisplay or view.

Value

An object of class vdbConn that contains the path and name of the VDB. This object is also assigned to the vdbConn option, and can be retrieved via getOption("vdbConn")

Examples

1
2
conn <- vdbConn(tempfile(), name = "myvdb", autoYes = TRUE)
conn

trelliscope documentation built on May 19, 2017, 10:15 p.m.

Search within the trelliscope package
Search all R packages, documentation and source code