cor2: Utility function

View source: R/utilities.R

cor2R Documentation

Utility function

Description

Called by various functions to calculate Pearson or angular correlation matrices.

Usage

cor2(x, y = NULL, circ = FALSE)

Arguments

x

a matrix.

y

an optional second matrix.

circ

If TRUE, the observations are assumed to be angular (in radians), and circular correlation is used. If FALSE, Pearson product moment correlations is returned.

Details

An auxilliary function to ease the maintenance.

Value

A correlation matrix is returned.

References

Jammalamadaka, S. Rao and SenGupta, A. (2001). Topics in Circular Statistics, Section 8.2, World Scientific Press, Singapore.


bjornsta/ncf documentation built on June 3, 2022, 11:43 a.m.