This function constructs a diamond plot using
It's normally not necessary to call this function directly: instead, use
diamondPlot( data, ciCols = 1:3, colorCol = NULL, otherAxisCol = NULL, yValues = NULL, yLabels = NULL, ylab = NULL, autoSize = NULL, fixedSize = 0.15, xlab = "Effect Size Estimate", theme = ggplot2::theme_bw(), color = "black", returnLayerOnly = FALSE, outputFile = NULL, outputWidth = 10, outputHeight = 10, ggsaveParams = ufs::opts$get("ggsaveParams"), ... )
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).
The column in the dataframe containing the values that
determine where on the Y axis the diamond should be placed. If this is not
available in the dataframe, specify it manually using
The values that determine where on the Y axis the diamond
should be placed (can also be a column in the dataframe; in that case, use
The labels to use for for each diamond (placed on the Y axis).
Whether to make the height of each diamond conditional upon its length (the width of the confidence interval).
If not using relative heights,
the height to use.
The labels of the X and Y axes.
The theme to use.
Color to use if colors are specified for each diamond.
Set this to TRUE to only return the
ggplot() layer of the diamondplot, which can be useful to
include it in other plots.
A file to which to save the plot.
Width and height of saved plot (specified in
centimeters by default, see
Parameters to pass to ggsave when saving the plot.
Additional arguments will be passed to
tmpDf <- data.frame(lo = c(1, 2, 3), mean = c(1.5, 3, 5), hi = c(2, 4, 10), color = c('green', 'red', 'blue')); ### A simple diamond plot diamondPlot(tmpDf); ### A diamond plot using the specified colours diamondPlot(tmpDf, colorCol = 4); ### A diamond plot using automatically generated colours ### using a gradient diamondPlot(tmpDf, generateColors=c('green', 'red')); ### A diamond plot using automatically generated colours ### using a gradient, specifying the minimum and maximum ### possible values that can be attained diamondPlot(tmpDf, generateColors=c('green', 'red'), fullColorRange=c(1, 10));