sendimage {sendplot}R Documentation

INTERACTIVE IMAGE

Description

This function is a wrapper to sendplot that will create a single interactive image

Usage

sendimage(plot.call,
          x, y, z,
          z.value="value",
          x.lbls = NA,y.lbls=NA,xy.lbls=NA,
          mai=NA, mai.prc=FALSE,plt.extras=NA,
          bound.pt=FALSE, source.plot=NA,
          paint=FALSE, img.prog=NA,
          resize="800x1100",
          ps.paper="letter",ps.width=8,ps.height=11,
          fname.root="test",dir="./",header="v2",
          up.left=c(188,103),low.right=c(648,912),
          spot.radius=5, automap=FALSE, automap.method="mode")

Arguments

plot.call character vector containing single plot call
x vector of x locations for interactive points
y vector of y locations for interactive points
z vector of z values for image call
z.value character vector indicating the label for what the z argument holds.
x.lbls data frame of n x m which contatins values relating to the x axis of the plot call. n should be the length of the x argument. m columns contains information regarding sample. This information is displayed in the interactive plot window
y.lbls data frame of n x m which contatins values relating to the y axis of the plot. n should be the length of the y argument. m columns contains information regarding sample. This information is displayed in the interactive plot window
xy.lbls list of matricies. All matricies should be of n x m where n is the length of y and m is the length of x. This information is displayed in the interactive plot window
mai margins for each side of the plot.If NA uses default margins
plt.extras List of additional plotting calls that should be executed for the plot.
mai.prc logical indicating if mai mat values are percentages or hard coded values. If mai.proc is T, indicates percentage.
bound.pt logical indicating if red points should be plotted to aid in finding the upper left and lower right coordinates. If bound.pt is FALSE, indicates that up.left and low.right arguments are correct and will make the html file
source.plot Indicates whether application should make a postscript file and then convert to png file, or if the png file should be made directly. This value is either ps, png, or NA. If NA the operating system is checked and the appropraite file format is output. Unix has a convert function that can convert a ps file to png file; we by default use this setup because we feel the postscript file maintains better quality. So on unix/linux systems if source.plot is NA, source.plot will be set to ps. Windows does not have this option, for this reason source.plot will be set to png if left NA
paint logical indicating if application should automatically open .png file for the user to view .png file and/or to retrieve needed bounding values of the plot call
img.prog If paint is TRUE, the command line call that will open a program to view .png file to retrieve pixil locations of interactive plot bounds. If this is left NA, the operating system is checked and a default program is used. For unix the default application is kolourpaint and for windows it is microsoft paint (mspaint)
resize character indicating resize value. The postscript version will be resized to this value when converted to .png.
ps.paper postscript paper argument
ps.width poscript width argument
ps.height postscript height argument
fname.root Base name to use for posctscript, .png, and html file names.
dir directory path to where files should be created
header May either be v1 or v2. This determines which tooltip header will be in the html file. Each version has different features or works well with different web browsers. see sp.header for details.
up.left The x and y value in pixels of the upper left hand corner of the plot call
low.right The x and y value in pixels of the lower right hand corner of the plot call.
spot.radius radius of circle in pixels indicating area that will be interactive around the center of interactive points
automap automatic detection of up.left and low.right bound points. Fully functional on linux/unix machines only.
automap.method Method to detect upper and lower bounds. Current options are mode or median

Details

This function is a wrapper for the sendplot function to create a single interacive image. See sendplot for more information.

Users are encouraged to read the package vignette which includes a detailed discussion of all function arguments as well as several useful examples.

Value

Creates a static .ps and .png file, and an interactive html file

Note

The interactive html plot currently only works in web browsers that implement java script.

The code used to create the javascript embedded in html file is a modified version of the javascript code or from the open source tooltip library. see reference links

Author(s)

Lori A. Shepherd, Daniel P. Gaile

References

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, sendxy, heatmap.send

Examples

# load the library 
   library("sendplot")

# set up vectors x,y, and z
   x = 1:4
   y = 1:8
   z = t(matrix(rnorm(32), ncol=4))

# create plot call for graph
  plot.calls = "image(x=x, y=y, z=z)"

# run sendImage
# note: we have already figured out appropriate up.left and low.right
#      values. if these were not known, the function should be run
#      with bound.pt=T (and maybe kolourpaint=T) to find pixil
#      locations

 sendimage(plot.call = plot.calls, x=x, y=y, z=z,
           up.left=c(100,99),low.right=c(738,917),
           bound.pt=FALSE, source.plot=NA, paint=FALSE,
           img.prog=NA,fname.root="testImg"  )



[Package sendplot version 1.1.0 Index]