geom_corr: Correlation Layer
In Hy4m/linkET: Everything is Linkable

geom_corr

R Documentation

Correlation Layer

Description

This function can be used to add corrlation marker on a pairs plot.

Usage

geom_corr(
  mapping = NULL,
  data = NULL,
  stat = "identity",
  position = "lc",
  ...,
  method = "pearson",
  contain_all = TRUE,
  digits = 2,
  nsmall = 2,
  nudge_x = NULL,
  nudge_y = NULL,
  na.rm = FALSE,
  show.legend = NA,
  inherit.aes = TRUE
)

Arguments

`mapping`	Set of aesthetic mappings created by `aes()`. If specified and `inherit.aes = TRUE` (the default), it is combined with the default mapping at the top level of the plot. You must supply `mapping` if there is no plot mapping.
`data`	The data to be displayed in this layer. There are three options: If `NULL`, the default, the data is inherited from the plot data as specified in the call to `ggplot()`. A `data.frame`, or other object, will override the plot data. All objects will be fortified to produce a data frame. See `fortify()` for which variables will be created. A `function` will be called with a single argument, the plot data. The return value must be a `data.frame`, and will be used as the layer data. A `function` can be created from a `formula` (e.g. `~ head(.x, 10)`).
`stat`	The statistical transformation to use on the data for this layer, either as a `ggproto` `Geom` subclass or as a string naming the stat stripped of the `stat_` prefix (e.g. `"count"` rather than `"stat_count"`)
`position`	position of correlation marker.
`...`	other parameters passed to layer function.
`method`	method of correlation.
`contain_all`	logical, if FALSE will contain each group marker only.
`digits, nsmall`	a positive integer to format correlation.
`nudge_x, nudge_y`	horizontal and vertical adjustment to nudge labels by.
`na.rm`	if FALSE, the default, missing values are removed with a warning, and if TRUE, missing values are silently removed.
`show.legend`	logical. Should this layer be included in the legends? `NA`, the default, includes if any aesthetics are mapped. `FALSE` never includes, and `TRUE` always includes. It can also be a named logical vector to finely select the aesthetics to display.
`inherit.aes`	If `FALSE`, overrides the default aesthetics, rather than combining with them. This is most useful for helper functions that define both data and aesthetics and shouldn't inherit behaviour from the default plot specification, e.g. `borders()`.