igbSession-class: Class '"igbSession"'

In gmbecker/rigbLite: Control IGB From R

Description

A reference class representing a running external IGB session

Extends

All reference classes extend and inherit methods from "envRefClass".

Methods

region<-

Set the region in the represented IGB session.

track<-

Display the track in the represented IGB session

snapshot

Instruct IGB to save a snapshot (image) of the current view

Constructor

igbSession objects are created by calling the igbSession function. This function accepts an argument for each field listed below and constructs the requested igbSession object. See example below.

Fields

port:

Port to which corresponding IGB session is listening for instructions. Defaults to 7085

host:

Host on which corresponding IGB session is running. Defaults to localhost.

connection:

Socket connection to port for use in communicating with IGB

Class-Based Methods

showTrack(x, ...):

Display a igbTrack.

initialize(...):

~~

setRegion(x):

Set viewing region

Author(s)

Gabriel Becker

See Also

igbTrack, igbTrackList

Examples

## Not run: 
igb = igbSession(host = "myhost", port = 8000)

## End(Not run)

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