man/colVarDiffs-dgCMatrix-method.Rd
17c056e4
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/methods.R, R/methods_row.R
 \name{colVarDiffs,dgCMatrix-method}
 \alias{colVarDiffs,dgCMatrix-method}
 \alias{rowVarDiffs,dgCMatrix-method}
2a924115
 \title{Calculates the variance of the difference between each element of a row
 (column) of a matrix-like object}
17c056e4
 \usage{
8ee76bde
 \S4method{colVarDiffs}{dgCMatrix}(x, rows = NULL, cols = NULL, na.rm = FALSE, diff = 1L, trim = 0)
17c056e4
 
8ee76bde
 \S4method{rowVarDiffs}{dgCMatrix}(x, rows = NULL, cols = NULL, na.rm = FALSE, diff = 1L, trim = 0)
17c056e4
 }
 \arguments{
 \item{x}{An NxK matrix-like object.}
 
7f055a6a
 \item{rows}{A \code{\link{vector}} indicating the subset of rows
 (and/or columns) to operate over. If \code{\link{NULL}}, no subsetting is
 done.}
17c056e4
 
7f055a6a
 \item{cols}{A \code{\link{vector}} indicating the subset of rows
 (and/or columns) to operate over. If \code{\link{NULL}}, no subsetting is
 done.}
17c056e4
 
7f055a6a
 \item{na.rm}{If \code{\link[base:logical]{TRUE}}, \code{\link{NA}}s
17c056e4
 are excluded first, otherwise not.}
 
 \item{diff}{An integer specifying the order of difference.}
 
2a924115
 \item{trim}{A double in [0,1/2] specifying the fraction of observations to
 be trimmed from each end of (sorted) x before estimation.}
17c056e4
 }
 \value{
7f055a6a
 Returns a \code{\link{numeric}} \code{\link{vector}} of length N (K).
17c056e4
 }
 \description{
2a924115
 Calculates the variance of the difference between each element of a row
 (column) of a matrix-like object.
17c056e4
 }
 \details{
7f055a6a
 The S4 methods for \code{x} of type \code{\link{matrix}},
 \code{\link{array}}, or \code{\link{numeric}} call
c72ed713
 \code{matrixStats::rowVarDiffs}
 / \code{matrixStats::colVarDiffs}.
17c056e4
 }
 \examples{
 mat <- matrix(rnorm(15), nrow = 5, ncol = 3)
   mat[2, 1] <- NA
   mat[3, 3] <- Inf
   mat[4, 1] <- 0
   
   print(mat)
   
   rowVarDiffs(mat)
   colVarDiffs(mat)
 }
 \seealso{
 \itemize{
87e1854b
 \item \code{matrixStats::\link[matrixStats:varDiff]{rowVarDiffs}()} and
 \code{matrixStats::\link[matrixStats:varDiff]{colVarDiffs}()} which
7f055a6a
 are used when the input is a \code{matrix} or \code{numeric} vector.
17c056e4
 \item for the direct variance see \code{\link[MatrixGenerics:rowVars]{rowVars()}}.
 }
 }