describe.ggobi {Rggobi}R Documentation

Provide a description of one or more ggobi instances

Description

This returns a description of each of the ggobi instances identified in the arguments. These should be specified as objects of class ggobi. The result describes the current state of the ggobi instance, including its datasets and displays.

Usage

describe.ggobi(..., full = FALSE)

Arguments

... any number of ggobi objects. If no values are specfied, all GGobi instances are used.
full (currently ignored) a logical value indicating whether the full or brief description should be returned for each ggobi instance.

Value

This returns a list with as many elements as there are ggobi instances specfied. Each element is a list of length $3$ with elements:

datasets a named list describing each dataset within this ggobi instance. Each description consists of
name
a character vector containing the name of the dataset and the (primary) file from which it was read.
dims
the number of records and variables in the dataset.
format
the data format of the file from which the data was read (e.g. XML, ASCII, binary, MySQL, etc.)
variables
a character vector giving the names of the variables
auxillaryFiles
any additional files that were read when processing the primary file (e.g. links in the XML file, .col and .rows files in ASCII format, etc.)
displays a list describing each of the displays within
ggobi the ggobi instance from which this description was obtained

Author(s)

Duncan Temple Lang

References

http://www.ggobi.org

See Also

ggobi getGGobi

Examples

 ggobi(args=c("-noinit", "-verbose", "-xml", system.file("data", "COI.xml", package="Rggobi")))
 describe.ggobi()
[Package Rggobi version 1.1-2 Index]