man/colCollapse-dgCMatrix-method.Rd
ef7cdb2a
 % Generated by roxygen2: do not edit by hand
17c056e4
 % Please edit documentation in R/methods.R, R/methods_row.R
ef7cdb2a
 \name{colCollapse,dgCMatrix-method}
 \alias{colCollapse,dgCMatrix-method}
17c056e4
 \alias{rowCollapse,dgCMatrix-method}
ef7cdb2a
 \title{Extract one cell from each row (column) of a matrix-like object}
 \usage{
8ee76bde
 \S4method{colCollapse}{dgCMatrix}(x, idxs, cols = NULL)
17c056e4
 
8ee76bde
 \S4method{rowCollapse}{dgCMatrix}(x, idxs, rows = NULL)
ef7cdb2a
 }
 \arguments{
 \item{x}{An NxK matrix-like object.}
 
7f055a6a
 \item{idxs}{An index \code{\link{vector}} with the position to extract.
ef7cdb2a
 It is recycled to match the number of rows (column)}
 
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.}
ef7cdb2a
 
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.}
ef7cdb2a
 }
 \value{
7f055a6a
 Returns a \code{\link{numeric}} \code{\link{vector}} of length N (K).
ef7cdb2a
 }
 \description{
2a924115
 Extract one cell from each row (column) of a matrix-like object.
ef7cdb2a
 }
 \details{
7f055a6a
 The S4 methods for \code{x} of type \code{\link{matrix}},
 \code{\link{array}}, or \code{\link{numeric}} call
c72ed713
 \code{matrixStats::rowCollapse}
 / \code{matrixStats::colCollapse}.
ef7cdb2a
 }
 \examples{
 mat <- matrix(rnorm(15), nrow = 5, ncol = 3)
   mat[2, 1] <- NA
   mat[3, 3] <- Inf
   mat[4, 1] <- 0
   
   print(mat)
   
   rowCollapse(mat, idxs = 2)
   rowCollapse(mat, idxs = c(1,1,2,3,2))
   
   colCollapse (mat, idxs = 4)
 }
 \seealso{
 \itemize{
 \item \code{matrixStats::\link[matrixStats]{rowCollapse}()} and
7f055a6a
 \code{matrixStats::\link[matrixStats:rowCollapse]{colCollapse}()}
 which are used when the input is a \code{matrix} or \code{numeric} vector.
ef7cdb2a
 }
 }