snapshot: Take a Snapshot in an External Genome Browser

In gmbecker/rigbLite: Control IGB From R

Description

Instruct an external Genome Browser to take a snapshot of its current display and save it to a specified file.

Usage

snapshot(session, filename, ...)

Arguments

session	Object representing the genome browser to communicate with
filename	Desired name of the image file to be created.
...	Additional options to be passed to individual methods.

Value

This function does not return a meaningful value.

Note

This function will create a snapshot image *on the machine IGB is running on*. If the user is communicating with a remote instance of IGB, the image will be created on the remote server, not the client machine.

Note

The snapshot method supports all file exensions that are supported by IGB. To see which file types are supported, navigate in the IGB menu to File -> Export -> Main View and inspect the file type options offered there. This notably includes the PDF and SVG formats among others.

Note

Certain versions of IGB do not support use of ~ in paths to indicate the user's home directory. For maximum reliability absolute paths should be used.

Author(s)

Gabriel Becker

Examples

## Not run: 

myigb = igbSession()
snapshot(myigb, "/home/user/myIGBsnapshots/mysnapshot.svg")

## End(Not run)

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