var {circular}

Variance

Description

The var function from the stats is replace by a new method in order to report the variance of circular data appropriately. var.default is an alias of the original function var see cor. The behavior would be the same for objects which are not from class data.frame and circular (in the last case the variance is define as one minus the mean resultant length divided by the sample size of data, see var.circular for more details). The method for data.frame will apply the var function to each columns.

Usage

var(x, ...)
## Default S3 method:
var(x, y = NULL, na.rm = FALSE, use, ...)
## S3 method for class 'data.frame'
var(x, ...)

Arguments

x

a numeric vector, matrix or data frame.

y

NULL (default) or a vector, matrix or data frame with compatible dimensions to x. The default is equivalent to y = x (but more efficient).

na.rm

logical. Should missing values be removed?

use

an optional character string giving a method for computing covariances in the presence of missing values. This must be (an abbreviation of) one of the strings "all.obs", "complete.obs" or "pairwise.complete.obs".

...

further arguments passed to or from other methods.

See Also

cor, var.circular, rho.circular and summary.circular.