ViewInIGB: Manipulate Current View in IGB Session

Description Usage Arguments Details Value Author(s) References See Also Examples

Description

Manipulate view and load data in a running IGB session.

Usage

1
ViewInIGB(x, genome = NULL, dataFile = NULL, region = NULL, loadMode = "REGION_IN_VIEW", refresh = TRUE, con = socketConnection("localhost", port = 7085, open = "wa"))

Arguments

x

Main item to load. This can be an igbTrack, a QuickloadGenome, a Quickload object, or NULL.

genome

A character value indicating the genome to be loaded

dataFile

Character value indicating a file containing data to load. See details.

region

A GRanges object indicating the viewing region desired or NULL for the default. Should contain one range with the name of the chromosome to view in the seqnames slot.

loadMode

Character value indicating how the data should be loaded. Must be one of "REGION_IN_VIEW", "WHOLE_CHROMOSOME", and "WHOLE_GENOME"

refresh

Logical indicating whether the view should be refreshed after loading the data. Defaults to TRUE.

con

A (socket) connection to a running IGB session.

Details

This generic function and it's methods are simply convenienve wrappers around the showInIGB function.

In the case that x is a QuickloadGenome object, dataFile is assumed to be a path relative to the specified genome within the specified Quickload bed, ie <uri(x)>/genome/dataFile.

In the case that x is a Quickload object, dataFile is assumed to be a path relative to the specified genome within the specified Quickload bed, ie <uri(x)>/genome/dataFile.

In all other cases dataFile is assumed to be an absolute path or URL.

In the case that any type of information is included in both x and a separate argument (eg x is a QuickloadGenome and genome is non-null) values corresponding to x are always used.

Value

The return value is not meaningful. When the function is called the effects should be immediately apparent in the running IGB session.

Author(s)

Gabriel Becker

References

Vora, Hiral. "Scripting", IGB User's Guide, bioviz, Nov 1, 2011. http://wiki.transvar.org/confluence/display/igbman/Scripting

See Also

showInIGB

Examples

1
2
3
4
5
6
7
## Not run: 
 igbS = igbSession$new()
 ViewInIGB(genome = "H_sapiens_Feb_2009", dataFile =
 "http://netaffxdas.affymetrix.com/quickload_data/H_sapiens_Feb_2009/cytoBand.cyt",
 con = igbS$connection)

## End(Not run)

gmbecker/rigbLite documentation built on May 17, 2019, 6:44 a.m.