1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/colIQRDiffs.R, R/colMadDiffs.R, R/colSdDiffs.R,
% R/colVarDiffs.R, R/rowIQRDiffs.R, R/rowMadDiffs.R, R/rowSdDiffs.R,
% R/rowVarDiffs.R
\name{colIQRDiffs,DelayedMatrix-method}
\alias{colIQRDiffs,DelayedMatrix-method}
\alias{colMadDiffs,DelayedMatrix-method}
\alias{colSdDiffs,DelayedMatrix-method}
\alias{colVarDiffs,DelayedMatrix-method}
\alias{rowIQRDiffs,DelayedMatrix-method}
\alias{rowMadDiffs,DelayedMatrix-method}
\alias{rowSdDiffs,DelayedMatrix-method}
\alias{rowVarDiffs,DelayedMatrix-method}
\title{Calculates the interquartile range of the difference between each element of
a row (column) of a matrix-like object}
\usage{
\S4method{colIQRDiffs}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
na.rm = FALSE,
diff = 1L,
trim = 0,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{colMadDiffs}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
na.rm = FALSE,
diff = 1L,
trim = 0,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{colSdDiffs}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
na.rm = FALSE,
diff = 1L,
trim = 0,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{colVarDiffs}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
na.rm = FALSE,
diff = 1L,
trim = 0,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{rowIQRDiffs}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
na.rm = FALSE,
diff = 1L,
trim = 0,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{rowMadDiffs}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
na.rm = FALSE,
diff = 1L,
trim = 0,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{rowSdDiffs}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
na.rm = FALSE,
diff = 1L,
trim = 0,
force_block_processing = FALSE,
...,
useNames = TRUE
)
\S4method{rowVarDiffs}{DelayedMatrix}(
x,
rows = NULL,
cols = NULL,
na.rm = FALSE,
diff = 1L,
trim = 0,
force_block_processing = FALSE,
...,
useNames = TRUE
)
}
\arguments{
\item{x}{A NxK \linkS4class{DelayedMatrix}.}
\item{rows, cols}{A \code{\link{vector}} indicating the subset of rows
(and/or columns) to operate over. If \code{\link{NULL}}, no subsetting is
done.}
\item{na.rm}{If \code{\link[base]{TRUE}}, missing values
(\code{\link[base]{NA}} or \code{\link[base]{NaN}}) are
omitted from the calculations.}
\item{diff}{An integer specifying the order of difference.}
\item{trim}{A double in [0,1/2] specifying the fraction of observations to
be trimmed from each end of (sorted) x before estimation.}
\item{force_block_processing}{\code{FALSE} (the default) means that a
seed-aware, optimised method is used (if available). This can be overridden
to use the general block-processing strategy by setting this to \code{TRUE}
(typically not advised). The block-processing strategy loads one or more
(depending on \verb{\link[DelayedArray]\{getAutoBlockSize\}()}) columns (\code{colFoo()})
or rows (\code{rowFoo()}) into memory as an ordinary \link[base:array]{base::array}.}
\item{...}{Additional arguments passed to specific methods.}
\item{useNames}{If \code{\link{TRUE}} (default), names attributes of result are set. Else if \code{\link{FALSE}}, no naming support is done.}
}
\value{
Returns a \code{\link{numeric}} \code{\link{vector}} of length N (K).
}
\description{
Calculates the interquartile range of the difference between each element of
a row (column) of a matrix-like object.
}
\details{
The S4 methods for \code{x} of type \code{\link{matrix}},
\code{\link{array}}, \code{\link{table}}, or \code{\link{numeric}} call
\code{matrixStats::\link[matrixStats]{rowIQRDiffs}} /
\code{matrixStats::\link[matrixStats]{colIQRDiffs}}.
}
\examples{
# A DelayedMatrix with a 'Matrix' seed
dm_Matrix <- DelayedArray(Matrix::Matrix(c(rep(1L, 5),
as.integer((0:4) ^ 2),
seq(-5L, -1L, 1L)),
ncol = 3))
# A DelayedMatrix with a 'SolidRleArraySeed' seed
dm_Rle <- RleArray(Rle(c(rep(1L, 5),
as.integer((0:4) ^ 2),
seq(-5L, -1L, 1L))),
dim = c(5, 3))
colIQRDiffs(dm_Matrix)
colMadDiffs(dm_Matrix)
colSdDiffs(dm_Matrix)
colVarDiffs(dm_Matrix)
# Only using rows 2-4
rowIQRDiffs(dm_Rle, rows = 2:4)
# Only using rows 2-4
rowMadDiffs(dm_Rle, rows = 2:4)
# Only using rows 2-4
rowSdDiffs(dm_Rle, rows = 2:4)
# Only using rows 2-4
rowVarDiffs(dm_Rle, rows = 2:4)
}
\seealso{
\itemize{
\item \code{matrixStats::\link[matrixStats:varDiff]{rowIQRDiffs}()} and
\code{matrixStats::\link[matrixStats:varDiff]{colIQRDiffs}()} which
are used when the input is a \code{matrix} or \code{numeric} vector.
\item For the direct interquartile range see also \link[MatrixGenerics]{rowIQRs}.
}
}
\author{
Peter Hickey
}
|