Description Usage Arguments Value Author(s) See Also Examples

View source: R/ggDiamondLayer.R

These functions are used by `diamondPlot`

to construct a diamond plot. It's normally not necessary to call this function directly: instead, use `meansDiamondPlot`

, `meanSDtoDiamondPlot`

, and `factorLoadingDiamondCIplot`

.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | ```
ggDiamondLayer(data, ciCols = 1:3,
colorCol = NULL,
generateColors = NULL,
fullColorRange = NULL,
color = "black",
lineColor=NA,
otherAxisCol = 1:nrow(data),
autoSize = NULL,
fixedSize = 0.15,
direction="horizontal",
...)
diamondCoordinates(values,
otherAxisValue = 1,
direction = "horizontal",
autoSize = NULL,
fixedSize = 0.15)
varsToDiamondPlotDf(dat, items = NULL,
labels = NULL, decreasing = NULL,
conf.level = 0.95)
rawDataDiamondLayer(dat, items = NULL,
itemOrder = 1:length(items),
dataAlpha = 0.1, dataColor = "#444444",
jitterWidth = 0.5, jitterHeight = 0.4,
size = 3, ...)
``` |

`data, dat` |
A dataframe (or matrix) containing lower bounds, centers (e.g. means), and upper bounds of intervals (e.g. confidence intervals) for |

`ciCols` |
The columns in the dataframe with the lower bounds, centers (e.g. means), and upper bounds (in that order). |

`colorCol` |
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). |

`generateColors` |
A vector with colors to use to generate a gradient. These colors must be valid arguments to |

`fullColorRange` |
When specifying a gradient using |

`color` |
When no colors are automatically generated, all diamonds will have this color. |

`lineColor` |
If NA, lines will have the same colors as the diamonds' fill. If not NA, must be a valid color, which is then used as line color. Note that e.g. |

`otherAxisCol` |
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. |

`autoSize` |
Whether to make the height of each diamond conditional upon its length (the width of the confidence interval). |

`fixedSize` |
If not using relative heights, |

`...` |
Any additional arguments are passed to |

`values` |
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. |

`otherAxisValue` |
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 |

`direction` |
Whether the diamonds should be constructed horizontally or vertically. |

`items` |
The items from the dataframe to include in the diamondplot or dataframe. |

`labels` |
The item labels to add to the dataframe. |

`decreasing` |
Whether to sort the items (rows) in the dataframe decreasing (TRUE), increasing (FALSE), or not at all (NULL). |

`conf.level` |
The confidence of the confidence intervals. |

`itemOrder` |
Order of the items to use (if not sorting). |

`dataAlpha` |
This determines the alpha (transparency) of the data points. |

`dataColor` |
The color of the data points. |

`jitterWidth` |
How much to jitter the individual datapoints horizontally. |

`jitterHeight` |
How much to jitter the individual datapoints vertically. |

`size` |
The size of the data points. |

`ggDiamondLayer`

returns a `ggplot`

`geom_polygon`

object, which can then be used in `ggplot`

plots (as `diamondPlot`

does).

`diamondCoordinates`

returns a set of four coordinates that together specify a diamond.

`varsToDiamondPlotDf`

returns a dataframe of diamondCoordinates.

`rawDataDiamondLayer`

returns a `geom_jitter`

object.

Gjalt-Jorn Peters

Maintainer: Gjalt-Jorn Peters <gjalt-jorn@userfriendlyscience.com>

`meansDiamondPlot`

, `meanSDtoDiamondPlot`

, `factorLoadingDiamondCIplot`

, `diamondPlot`

1 2 3 4 5 6 7 8 9 10 11 12 | ```
## 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)
``` |

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.