aad: Mean (average) absolute deviation from the mean

Description Usage Arguments Details Value Warning Author(s) See Also Examples

Description

Calculates the mean absolute deviation from the sample mean.

Usage

1
aad(x, na.rm = FALSE)

Arguments

x

A vector containing the observations.

na.rm

A logical value indicating whether or not missing values should be removed. Defaults to FALSE

Details

The aad function calculates the average (i.e. mean) absolute deviation from the mean value of x, removing NA values if requested by the user. It exists primarily to simplify the discussion of descriptive statistics during an introductory stats class.

Value

Numeric.

Warning

This package is under development, and has been released only due to teaching constraints. Until this notice disappears from the help files, you should assume that everything in the package is subject to change. Backwards compatibility is NOT guaranteed. Functions may be deleted in future versions and new syntax may be inconsistent with earlier versions. For the moment at least, this package should be treated with extreme caution.

Author(s)

Daniel Navarro

See Also

mad

Examples

1
2
3
4
5
6
7
8
# basic usage
X <- c(1, 3, 6)  # data 
aad(X)           # returns a value of 2

# removing missing data
X <- c(1, 3, NA, 6)   # data 
aad(X)                # returns NA 
aad(X, na.rm = TRUE)  # returns 2 

svannoy/lsr-package documentation built on May 30, 2019, 8:45 p.m.