removeImap: Removes Interactive Information to 'Splot' Object

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

View source: R/removeImap.R

Description

The removeImap function will remove interactive information for a given figure in a Splot Object. It will remove any information added by makeImap or addDefault.

Usage

1
2
3
4
5
6
removeImap(Splot,
           figure,
           subset=NA,
           returnVl=TRUE,
           saveFlag=FALSE,
           saveName="Splot.RData")

Arguments

Splot

An Object of the class Splot

figure

Indicates which plot figure to remove data from; this matches the numeric indication in the layout matrix. This may also be the value "Default" to remove a set Default tool-tip (see addDefault

subset

If default is a numeric indication of figure, which subsets of data to remove. If this is left as NA, all iMaps are removed.

returnVl

Should Splot object be returned

saveFlag

Should Splot object be saved

saveName

If saveFlag, path file name to save object

Details

The removeImap handles removing the Default toop-tip added by addDefault or any of a given figure's iMaps added by makeImap.

To remove all of a figure's iMaps, subset is NA. iMaps are stored in the order they are added. A subset will be a numeric indication of which iMap to remove based on this ordering.

Users are encouraged to see vignette for better details and examples.

Value

Returns or Saves the new Splot object with data removed

Note

Can only remove data from one figure at a time.

Author(s)

Lori A.Shepherd, Daniel P. Gaile

See Also

addDefault, makeImap, initSplot, makeSplot

Examples

1
# Please see vignette or makeSplot for example

lshep/sendplot documentation built on Nov. 18, 2017, 5:10 p.m.