R: Add Correlation Coefficients with P-values to a Scatter Plot

stat_cor {ggpubr} | R Documentation

## Add Correlation Coefficients with P-values to a Scatter Plot

### Description

Add correlation coefficients with p-values to a scatter plot.

### Usage

    stat_cor(mapping = NULL, data = NULL, method = "pearson",
      label.sep = ", ", label.x.npc = "left", label.y.npc = "top",
      label.x = NULL, label.y = NULL, geom = "text", position = "identity",
      na.rm = FALSE, show.legend = NA, inherit.aes = TRUE, ...)

### Arguments

`mapping` | Set of aesthetic mappings created by `aes()` or `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.
`method` | a character string indicating which correlation coefficient (or covariance) is to be computed. One of "pearson" (default), "kendall", or "spearman".
`label.sep` | a character string to separate the terms. Default is ", ", to separate the correlation coefficient and the p.value.
`label.x.npc, label.y.npc` | can be `numeric` or `character` vector of the same length as the number of groups and/or panels. If too short they will be recycled. If `numeric`, value should be between 0 and 1. Coordinates to be used for positioning the label, expressed in "normalized parent coordinates". If `character`, allowed values include: i) one of c('right', 'left', 'center', 'centre', 'middle') for x-axis; ii) and one of c( 'bottom', 'top', 'center', 'centre', 'middle') for y-axis. If too short they will be recycled.
`label.x, label.y` | `numeric` Coordinates (in data units) to be used for absolute positioning of the label. If too short they will be recycled.
`geom` | The geometric object to use display the data
`position` | Position adjustment, either as a string, or the result of a call to a position adjustment function.
`na.rm` | If FALSE (the default), removes missing values with a warning. If TRUE silently removes missing values.
`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()`.
`...` | other arguments to pass to `geom_text` or `geom_label`.

### See Also

`ggscatter`

### Examples

    # Load data
    data("mtcars")
    df <- mtcars
    df$cyl <- as.factor(df$cyl)

    # Scatter plot with correlation coefficient
    #:::::::::::::::::::::::::::::::::::::::::::::::::
    sp <- ggscatter(df, x = "wt", y = "mpg",
       add = "reg.line",  # Add regressin line
       add.params = list(color = "blue", fill = "lightgray"), # Customize reg. line
       conf.int = TRUE # Add confidence interval
       )
    # Add correlation coefficient
    sp + stat_cor(method = "pearson", label.x = 3, label.y = 30)

    # Color by groups and facet
    #::::::::::::::::::::::::::::::::::::::::::::::::::::
    sp <- ggscatter(df, x = "wt", y = "mpg",
       color = "cyl", palette = "jco",
       add = "reg.line", conf.int = TRUE)
    sp + stat_cor(aes(color = cyl), label.x = 3)

[Package ggpubr version 0.1.6 Index]