printCor: Print Objects

View source: R/printCor.R

printCorR Documentation

Print Objects

Description

Prints the results of a correlation test (cor.all) or correlation matrix in a compact form indicating positive or negative correlation.

Usage

printCor(x, criterion = 0.75)

Arguments

x

an object of class "cor.all" from cor.all or the output from cor.

criterion

a numeric value indicating the test criterion for showing a value.

Value

The object x is returned invisibly.

Note

The printed output is a compressed table showing "+" where the value in x is greater than criterion, "-" where the value in x is less than -criterion, "\" on the diagonal, if x is symmetric, and "." where x has a missing value, and " " otherwise.

See Also

cor.all

Examples

## Not run: 
library(smwrData)
data(TNLoads)
printCor(cor(TNLoads, method="spearman"), .5)

## End(Not run)

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