rowIQRs: Estimates of the interquartile range for each row (column) in...

Description Usage Arguments Value Missing values Author(s) See Also Examples

View source: R/rowIQRs.R

Description

Estimates of the interquartile range for each row (column) in a matrix.

Usage

1
2
3
4
5
rowIQRs(x, rows = NULL, cols = NULL, na.rm = FALSE, ...)

colIQRs(x, rows = NULL, cols = NULL, na.rm = FALSE, ...)

iqr(x, idxs = NULL, na.rm = FALSE, ...)

Arguments

x

A numeric NxK matrix.

na.rm

If TRUE, missing values are dropped first, otherwise not.

...

Additional arguments passed to rowQuantiles() (colQuantiles()).

idxs, rows, cols

A vector indicating subset of elements (or rows and/or columns) to operate over. If NULL, no subsetting is done.

Value

Returns a numeric vector of length N (K).

Missing values

Contrary to IQR, which gives an error if there are missing values and na.rm = FALSE, iqr() and its corresponding row and column-specific functions return NA_real_.

Author(s)

Henrik Bengtsson

See Also

See IQR. See rowSds().

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
set.seed(1)

x <- matrix(rnorm(50 * 40), nrow = 50, ncol = 40)
str(x)

# Row IQRs
q <- rowIQRs(x)
print(q)
q0 <- apply(x, MARGIN = 1, FUN = IQR)
stopifnot(all.equal(q0, q))

# Column IQRs
q <- colIQRs(x)
print(q)
q0 <- apply(x, MARGIN = 2, FUN = IQR)
stopifnot(all.equal(q0, q))

matrixStats documentation built on May 30, 2017, 1:05 a.m.

Search within the matrixStats package
Search all R packages, documentation and source code