man/colRanges-dgCMatrix-method.Rd
ea443157
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/methods.R, R/methods_row.R
 \name{colRanges,dgCMatrix-method}
 \alias{colRanges,dgCMatrix-method}
 \alias{rowRanges,dgCMatrix-method}
2a924115
 \title{Calculates the minimum and maximum for each row (column) of a matrix-like
 object}
ea443157
 \usage{
8ee76bde
 \S4method{colRanges}{dgCMatrix}(x, rows = NULL, cols = NULL, na.rm = FALSE)
ea443157
 
8ee76bde
 \S4method{rowRanges}{dgCMatrix}(x, rows = NULL, cols = NULL, na.rm = FALSE)
ea443157
 }
 \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.}
ea443157
 
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.}
ea443157
 
7f055a6a
 \item{na.rm}{If \code{\link[base:logical]{TRUE}}, \code{\link{NA}}s
ea443157
 are excluded first, otherwise not.}
 }
 \value{
7f055a6a
 a \code{\link{numeric}} \code{Nx2} (\code{Kx2})
2a924115
 \code{\link{matrix}}, where N (K) is the number of rows (columns) for
 which the ranges are calculated.
ea443157
 }
 \description{
2a924115
 Calculates the minimum and maximum for each row (column) of a matrix-like
 object.
ea443157
 }
 \details{
7f055a6a
 The S4 methods for \code{x} of type \code{\link{matrix}},
 \code{\link{array}}, or \code{\link{numeric}} call
c72ed713
 \code{matrixStats::rowRanges}
 / \code{matrixStats::colRanges}.
ea443157
 }
 \examples{
 mat <- matrix(rnorm(15), nrow = 5, ncol = 3)
   mat[2, 1] <- NA
   mat[3, 3] <- Inf
   mat[4, 1] <- 0
   
   print(mat)
   
   rowRanges(mat)
   colRanges(mat)
 }
 \seealso{
 \itemize{
 \item \code{matrixStats::\link[matrixStats]{rowRanges}()} and
7f055a6a
 \code{matrixStats::\link[matrixStats:rowRanges]{colRanges}()} which are
 used when the input is a \code{matrix} or \code{numeric} vector.
ef7cdb2a
 \item For max estimates, see \code{\link[MatrixGenerics]{rowMaxs}()}.
 \item For min estimates, see \code{\link[MatrixGenerics]{rowMins}()}.
7f055a6a
 \item \code{base::\link{range}()}.
ea443157
 }
 }