summary.cor.all: Summarize Correlations

View source: R/summary.cor.all.R

summary.cor.allR Documentation

Summarize Correlations

Description

Summarizes the correlations: method for "cor.all" object.

Usage

## S3 method for class 'cor.all'
summary(object, p.adjust = "holm", variable = NULL, ...)

Arguments

object

an object created by the cor.all function.

p.adjust

a character string describing the method to use to adjust the p-values to account for m ultiple comparisons. See p.adjust for the options and details.

variable

if the name of a variable, then summarize only those correlations of this variable with all others, otherwise summarize all combinations.

...

further arguments passed to or from other methods.

Value

A data frame containing columns of the paired variables, the correlation, the adjusted p-value, and the number of observations in the correlation.

See Also

cor.all

Examples

library(smwrData)
data(TNLoads)
# Extract only the correlations with the log of total nitrogen
summary(cor.all(TNLoads[, 1:5]), variable="LOGTN")

USGS-R/smwrStats documentation built on Oct. 11, 2022, 6:15 a.m.