sendplot (version 0.1.4)

sendxy: INTERACTIVE SCATTERPLOT

Description

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

Usage

sendxy(plot.call,
       x, y, 
       xy.lbls = NA,
       xlim = NA, ylim = NA,
       mai=NA, plt.extras=NA,
       bound.pt=TRUE, source.plot=NA,
       paint=TRUE,img.prog = NA,
       resize="800x1100",
       ps.paper="letter",ps.width=8,ps.height=11,
       fname.root="test",dir="./",
       up.left=c(205,131),low.right=c(633,883),
       spot.radius=10)

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

xy.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

xlim

xlim values for the plot. If left as NA, the range of x will be used.

ylim

ylim values for the plot. If left as NA, the range of y will be used.

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.

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

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

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

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

Value

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

Details

This function is a wrapper for the sendplot function to create a single interacive scatterplot. see sendplot for more information.

The plot call, x values, and y values will need to be specified. The graph created with the plot.call argument will be interactive in a web browser.The function uses information regarding x and y values to make a mapping that javascript can utilize. In order to map correctly, the x and y values need to be converted into pixel values. This is performed automatically, however it requires the knowledge of the upper left and lower right pixel coordinates of the bounding box of the scatterplot.These pixel coordinates change when the postscript file is converted into a .png file if the resize option is used. The .png file must be opened in some image viewer that allows the user to retrieve pixel coordinates.There are two possible scenerios for making a png file:the png file may be made directly, or a postscript file may be made first that then must be converted into a png file. We recommend the later because we feel it maintains better clarity and quality. Whether the ps or png file is made is controlled by source.plot. source.plot may be ps, png, or NA. If ps, the postscript file is created; if this option is chosen and the operating system is unix/linux there is an automatic call to the convert function to convert the postscript into a png file. If png, the .png file is created. If source.plot is NA, the operating system is checked and the appropriate file format is generated. By default, if the operating system is unix/linux, the postscript is created and then converted to png. If the operating system is windows or mac, the png file is created directly. If the ps option is used on windows or mac, it is up to the user to correctly convert the postscript to a png file format. As mentioned above, once the png file is created the pixil locations of the bounding box must be known. If paint is TRUE, the png file is openned with the program given by img.prog. If img.prog is NA, the application used to view the image is determined by the operating system. In windows,img.prog is mspaint which will open the .png file in microsoft paint. In linux/unix, img.prog is kolourpaint. img.prog may be any command line call to a graphics program for viewing .png files. As mentioned above, once the png file is created the pixil locations of the bounding box must be known. If paint is TRUE, the png file is openned with the program given by img.prog. If img.prog is NA, the application used to view the image is determined by the operating system. In windows,img.prog is mspaint which will open the .png file in microsoft paint.In linux/unix, img.prog is kolourpaint. img.prog may be any command line call to a graphics program for viewing .png files.The general plot call in R adds a buffer before the axis, for this reason we add two points at the bounding box. If bound.pt is T, two red points will appear in the scatterplot. When the file is opened in application such as kolourpaint or mspaint, the user need only to record the pixel location when the mouse hovers over these red points (NOTE: in kolourpaint and mspaint the pixel location appears on the bottom of the window).When bound.pt is TRUE the function assumes that the user needs to find the pixel locations of the bounding box and will not make the html file. The interactive html file is only created when bound.pt is FALSE. Once the upper left and lower right values are recorded, the user should rerun the same function call but updating the up.left and low.right with the values retrieved and with bound.pt = FALSE. This results in an html with embedded javascript to be created. The user may open the html file in a web browser that has javascript capabilities; we recommended using mozilla firefox (NOTE: Internet Explorer currently does not support this function. Capability issues will be resolved in future releases). The information that appears when a point is scrolled over is controlled by the function argument xy.lbls.

References

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

See Also

sendplot, sendimage

Examples

# load the library
  library("sendplot")

# create some vectors of points
   x1 = 1:7
   y1 = 1:7  
   x2 = 7:1
   y2 = rep(4,7)
# create master vector of all points
   x = c(x1,x2)
   y = c(y1,y2)

# create data frame of information to display in interactive  
   xy.lbls = list()
   xy.lbls$test = rep(c("a","b","c","d","e","f","g"),2)
   xy.lbls$num = 1:14
   xy.lbls = as.data.frame(xy.lbls)

# create plot.call for graph
   plot.calls = "plot(x1,y1,col='green', pch=3, cex=1.5); points(x2,y2,
pch=4, cex=1.5, col='purple')"


#
# Note this plot call could have also been run with 
#
#   plot.calls = "plot(x1,y1,col='green', pch=3, cex=1.5)"
#  
#  and then setting the
#        plt.extras$plot1 = "points(x2,y2,pch=4, cex=1.5, col='purple')"



# run sendxy
# 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 paint=T) to find pixil
#      locations
#
# The up.left and low.right values are correct if run in 
#  unix/linux environment - for window users the coordinates will not be
#  correct

  sendxy(plot.call = plot.calls, x=x, y=y,
         xy.lbls=xy.lbls, plt.extras=NA,
         bound.pt=FALSE, source.plot=NA, paint=FALSE,
         img.prog=NA,fname.root="testXY",
         up.left=c(179,106),low.right=c(646,915))