sendplot (version 4.0.0)

initSplot: Creates A Sendplot 'Splot' Object

Description

The initSplot function creates a sendplot 'Splot' object. A Splot object holds all necessary elements to make a static layout of images and, through other functions, all elements to make any of those images interactive with tool-tip display content

Usage

initSplot(mat,
          plot.calls,
          Iflag=NA,
          figTypes=NA,
          mai.mat=NA,
          mai.prc=FALSE,
          plot.extras = NA,
          source.plot=NA,
          image.size="800x1100",
          pointsize=12,
          res=NA,
          ps.paper="letter",
          ps.width=8,
          ps.height=11,
          returnVl=TRUE,
          saveFlag=FALSE,
          saveName="Splot.RData")

Arguments

mat
matrix indicating layout. This argument will be passed into the graphics package layout call as mat.Each value in the matrix must be '0' or a positive integer. If N is the largest positive integer in the matrix, then the integers 1,...,N-1 mu
plot.calls
character vector containing plot calls
Iflag
Logical vector indicating if the plot in the layout is interactive
figTypes
Character vector indicating the type of plot. Currently this argument is not needed, but will be useful for extensions that will be made in future versions.
mai.mat
n x 4 matrix of values to be passed in for each plots par mai. n is equal to the length of plot.calls. If NA, uses default margins
mai.prc
logical indicating if mai mat values are percentages or hard coded values. If mai.proc is T, indicates percentage.
plot.extras
List of length equal to the number of plot.calls. This object is a list of lists. The sublists contain any additional plotting calls that should be executed for the plot. Each entry must be a character vector. If no additional plotting is
source.plot
Indicates what image output the application should produce postscript, tiff, png, or jpeg. It can be a character vector of any combination of ps, png, jpeg, or tiff. If NA, the default will make a png file
image.size
character indicating resize value of image,'width'x'height'
pointsize
pointsize of image. passed into device call
res
resolution of image, passed into device call if png or jpeg
ps.paper
postscript paper argument if postscript is created
ps.width
postscript width argument if postscript is created
ps.height
postscript height argument if postscript is created
returnVl
Should Splot object be returned
saveFlag
Should Splot object be saved
saveName
If saveFlag, path file name to save object

Value

  • If returnVl, an object of the class 'Splot'

Details

This functio initializes a Splot object. This object stores information for constructing a layout of figures, as well as making any of thos figures interactive in a html webpage utilizing java tool-tip. Users are encouraged to read the package vignette which includes a detailed discussion of all function arguments as well as several useful examples.

References

http://www.R-project.org http://www.onlamp.com/pub/a/onlamp/2007/07/05/writing-advanced-javascript.html

http://www.walterzorn.com/tooltip/tooltip_e.htm

See Also

sendplot, makeImap, makeSplot, layout

Examples

Run this code
# Please see vignette or makeSplot for example

Run the code above in your browser using DataLab