Skip to contents

Correlation, Variance and Covariance (Matrices), Including Rvecs

Source: R/var.R
var.Rd

Calculate correlations and variances, including when x or y is an rvec.

Usage

var(x, y = NULL, na.rm = FALSE, use)

Arguments

x

A numeric vector, matrix, data frame, or rvec().

y

NULL (default) or a vector, matrix, data frame, or rvec with compatible dimensions to x.

na.rm

Whether NAs removed before calculations.

use

Calculation method. See stats::var().

Value

An rvec, if x or y is an rvec. Otherwise typically a numeric vector or matrix.

Details

To enable different behavior for rvecs and for ordinary vectors, the base R function stats::var() is turned into a generic, with stats::var() as the default.

For details on the calculations, see the documentation for stats::var().

See also

sd()

Examples

x <- rvec(cbind(rnorm(10), rnorm(10, sd = 20)))
x
#> <rvec_dbl<2>[10]>
#>  [1] 1.595,-44.29    0.3295,22.5     -0.8205,-0.8987 0.4874,-0.3238 
#>  [5] 0.7383,18.88    0.5758,16.42    -0.3054,11.88   1.512,18.38    
#>  [9] 0.3898,15.64    -0.6212,1.491  
var(x)
#> <rvec_dbl<2>[1]>
#> [1] 0.6502,385