Basic ggplot2 diamond plot layer construction functions
These functions are used by
diamondPlot to construct a diamond plot. It's normally not necessary to call this function directly: instead, use
ggDiamondLayer(data, ciCols = 1:3, colorCol = NULL, generateColors = NULL, fullColorRange = NULL, color = "black", otherAxisCol = 1:nrow(data), autoSize = NULL, fixedSize = 0.15, ...) diamondCoordinates(values, otherAxisValue = 1, direction = "horizontal", autoSize = NULL, fixedSize = 0.15)
- A dataframe (or matrix) containing lower bounds, centers (e.g. means), and upper bounds of intervals (e.g. confidence intervals).
- The columns in the dataframe with the lower bounds, centers (e.g. means), and upper bounds (in that order).
- The column in the dataframe containing the colors for each diamond, or a vector with colors (with as many elements as the dataframe has rows).
A vector with colors to use to generate a gradient. These colors must be valid arguments to
colorRamp(and therefore, to
When specifying a gradient using
generateColors, it is usually desirable to specify the minimum and maximum possible value corresponding to the outer anchors of that gradient. For example, when plotting numbers from 0 to 100 using a gradient from 'red' through 'orange' to 'green', none of the means may actually be 0 or 100; the lowest mean may be, for example, 50. If no
fullColorRangeis specified, the diamond representing that lowest mean of 50 wil be red, not orange. When specifying the
fullColorRange, the lowest and highest 'colors' in
generateColorsare anchored to the minimum and maximum values of
- When no colors are automatically generated, all diamonds will have this color.
- A vector of values, or the index of the column in the dataframe, that specifies the values for the Y axis of the diamonds. This should normally just be a vector of consecutive integers.
- Whether to make the height of each diamond conditional upon its length (the width of the confidence interval).
If not using relative heights,
fixedSizedetermines the height to use.
Any additional arguments are passed to
geom_polygon. This can be used to set, for example, the
alphavalue of the diamonds.
- A vector of 2 or more values that are used to construct the diamond coordinates. If three values are provided, the middle one becomes the diamond's center. If two, four, or more values are provided, the median becomes the diamond's center.
The value on the other axis to use to compute the coordinates; this will be the Y axis value of the points of the diamond (if
directionis 'horizontal') or the X axis value (if
- Whether the diamonds should be constructed horizontally or vertically.
## Not run: # ### (Don't run this example as a test, because we # ### need the ggplot function which isn't part of # ### this package.) # # ### The coordinates for a simple diamond # diamondCoordinates(values = c(1,2,3)); # # ### Plot this diamond # ggplot() + ggDiamondLayer(data.frame(1,2,3)); # ## End(Not run)
Looks like there are no examples yet.