spotfireBundle
Spotfire Bundle Objects

### Description

Creates or tests for Spotfire bundle objects.

### Usage

    spotfireBundle(x, bundleClass = NULL, description = NULL, displayNames = NULL)
    as.spotfireBundle(x, ...)
    is.spotfireBundle(x)

### Arguments

x |
spotfireBundle | a list of named bundle components.
as.spotfireBundle | any object, but typically a model.
is.spotfireBundle | any object.
bundleClass | a scalar character string specifying the bundle class name. The bundle class name is used by Spotfire to associate templates with the bundle.
description | a scalar character string that describes the bundle.
displayNames | a character vector of the same length as x. The display names are displayed in Spotfire instead of the named components of x.
... | additional arguments passed to the generic method.

### Details

A Spotfire bundle enables you to analyze models from SNext in Spotfire. Each model class needs to implement an as.spotfireBundle method. Currently there are methods for lm, glm, anova, and arbor.
The method extracts suitable information from the model and creates a Spotfire bundle with data.frame objects and scalar values that will be exported to Spotfire for futher analysis.
The data.frame objects are exported to data tables in Spotfire, and scalar values are exported to document properties.
By specifying a bundleClass, a Spotfire template can be associated with a bundle and this allows you to configure a suitable visualizations.
Value

spotfireBundle | returns a Spotfire bundle object with components from x.

as.spotfireBundle | is a generic S3 method. A spotfireBundle is constructed from x.

is.spotfireBundle | returns TRUE if the object x is a spotfireBundle. Otherwise, it returns FALSE.

See Also
data.frame, lm.
Examples

    d <- data.frame(a=11:13, b=letters[1:3])
    bundle <- spotfireBundle(list(MyTable=d, MyDocProp=3.14), bundleClass='myBundle', description='An example bundle')
    is.spotfireBundle(bundle) # TRUE
    m < lm(a ~ b, data=d)
    bundle <- as.spotfireBundle(m) # Create a bundle with bundleClass 'lm'

Package terrUtils version 6.1.5-18
Package Index