makeImageDF: Maps R x and y point coordinates to pixil coordinates for...

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

View source: R/makeImageDF.R

Description

NOT CALLED BY USER. The makeImageDF function is utilized by makeImap to map a set of R x and y coordinates to their corresponding pixil x and y coordinates. It also sets up data.frames of tool-tip information for display purpses

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
makeImageDF(Splot,
            xy.type,
            xlim, ylim,
            x.pos,y.pos,
            boundingPt,
            x.labels=NA,
            y.labels=NA,
            xy.labels=NA,
            x.links=NA,
            y.links=NA,
            xy.links=NA,
            asLinks=NA,
            x.images=NA,
            y.images=NA,
            xy.images=NA)

Arguments

Splot

An Object of the class Splot

xy.type

Indication of how the xpos and ypos values should be treated.Current options are "image.midpoint","image.boundaries", or "image.box".See details or vignette.

xlim

x limit of figure

ylim

y limit of figure

x.pos

numeric vector of x values for interactive points

y.pos

numeric vector of y values for interactive points

boundingPt

List with up.left and low.right pixil coordinates of the desired interactive figure's plotting region, as determined by automapPts

x.labels

data frame of n x m which contains values relating to the xpos. n should be the length of the xpos argument if xy.type is "image.midpoints" and length of xpos - 1 if xy.type is "image.boundaries" or "image.box". m columns contains information regarding sample. This information is displayed in the interactive plot window

y.labels

data frame of n x m which contains values relating to the yvec. n should be the length of the ypos argument if xy.type is "image.midpoints" and length of ypos - 1 if xy.type is "image.boundaries" or "image.box". m columns contains information regarding sample. This information is displayed in the interactive plot window

xy.labels

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 when xy.type is "image.midpoint". All matricies should be of n x m where n is the length of y -1 and m is the length of x - 1 when xy.type is "image.boundaries" or "image.box". This information is displayed in the interactive plot window

x.links

data frame of n x m which contains web addresses for links relating to the xpos. n should be the length of the xpos argument if xy.type is "image.midpoints" and length of xpos - 1 if xy.type is "image.boundaries" or "image.box". m columns contains information regarding sample. This information is displayed as hyperlinks in the interactive plot window.

y.links

data frame of n x m which contains web addresses for links relating to the ypos. n should be the length of the ypos argument if xy.type is "image.midpoints" and length of ypos - 1 if xy.type is "image.boundaries" or "image.box". m columns contains information regarding sample. This information is displayed as hyperlinks in the interactive plot window.

xy.links

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 when xy.type is "image.midpoint". All matricies should be of n x m where n is the length of y -1 and m is the length of x - 1 when xy.type is "image.boundaries" or "image.box". This information is displayed in the interactive plot window as hyperlinks. The values in these matricies should be complete web address

asLinks

contains complete web address for points that should be treated as hyperlinks. May be a data.frame or matrix of n x m where n is the length of ypos and m is the length of xpos, a vector of length xpos indicating xpos specific links that will be repeated, a vector of length ypos indicating ypos specific links that will be repeated, a non NA value of length 1 that will be repeated for all points, or a vector of length xpos*ypos. This assumes xy.type is "image.midpoints". If xy.type is "image.boundaries" or "image.box", then the lengths should be xpos-1 and ypos - 1. instead of xpos and ypos

x.images

data frame of n x m which contains paths to images relating to the xpos. n should be the length of the xpos argument if xy.type is "image.midpoints" and length of xpos - 1 if xy.type is "image.boundaries" or "image.box". m columns contains information regarding sample. This information is displayed as images in the interactive plot window.

y.images

data frame of n x m which contains paths to images relating to the ypos. n should be the length of the ypos argument if xy.type is "image.midpoints" and length of ypos - 1 if xy.type is "image.boundaries" or "image.box". m columns contains information regarding sample. This information is displayed as images in the interactive plot window.

xy.images

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 when xy.type is "image.midpoint". All matricies should be of n x m where n is the length of y -1 and m is the length of x - 1 when xy.type is "image.boundaries" or "image.box". This information is displayed in the interactive plot window as images. The values in these matricies should be complete paths to images

Details

This function uses the x and y limits of the R plots and the boundaries of the figure to convert plot points to pixil coordinates.

image.box will make rectangular regions for an image interactive based on the given xpos and ypos boundaries. image.midpoints and image.boundaries will make the center of the regions of an image interactive based on the given xpos and ypos. image.midpoints assumes the xpos and ypos are the actual locations. image.boundaries assumes the xpos and ypos are the boundary cuts and calculates the midpoints.

The data matricies are checked for proper lengths and returned as a MapObj.

Value

List containing objects with interactive information.

Note

NOT CALLED BY USER. INTERNAL HELPER FUNCTION

Author(s)

Lori A. Shepherd, Daniel P. Gaile

See Also

makeImap, automapPts

Examples

1
# not called by user

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