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
|
\name{matrixStats-methods}
\alias{matrixStats-methods}
\alias{rowSums}
\alias{rowSums,DelayedMatrix-method}
\alias{colSums}
\alias{colSums,DelayedMatrix-method}
\alias{rowMeans}
\alias{rowMeans,DelayedMatrix-method}
\alias{colMeans}
\alias{colMeans,DelayedMatrix-method}
\alias{rowMins}
\alias{rowMins,DelayedMatrix-method}
\alias{colMins}
\alias{colMins,DelayedMatrix-method}
\alias{rowMaxs}
\alias{rowMaxs,DelayedMatrix-method}
\alias{colMaxs}
\alias{colMaxs,DelayedMatrix-method}
\alias{rowRanges}
\alias{rowRanges,DelayedMatrix-method}
\alias{colRanges}
\alias{colRanges,DelayedMatrix-method}
\alias{rowVars}
\alias{rowVars,DelayedMatrix-method}
\alias{colVars}
\alias{colVars,DelayedMatrix-method}
\title{DelayedMatrix row/col summarization}
\description{
Only a small number of row/col summarization methods are provided by
the \pkg{DelayedArray} package.
See the \pkg{DelayedMatrixStats} package for an extensive set of
row/col summarization methods.
}
\usage{
## N.B.: Showing ONLY the col*() methods (usage of row*() methods is
## the same):
\S4method{colSums}{DelayedMatrix}(x, na.rm=FALSE, dims=1)
\S4method{colMeans}{DelayedMatrix}(x, na.rm=FALSE, dims=1)
\S4method{colMins}{DelayedMatrix}(x, rows=NULL, cols=NULL, na.rm=FALSE, useNames=TRUE)
\S4method{colMaxs}{DelayedMatrix}(x, rows=NULL, cols=NULL, na.rm=FALSE, useNames=TRUE)
\S4method{colRanges}{DelayedMatrix}(x, rows=NULL, cols=NULL, na.rm=FALSE, useNames=TRUE)
\S4method{colVars}{DelayedMatrix}(x, rows=NULL, cols=NULL, na.rm=FALSE, center=NULL, useNames=TRUE)
}
\arguments{
\item{x}{
A \link{DelayedMatrix} object.
}
\item{na.rm, useNames, center}{
See man pages for the corresponding generics in the \pkg{MatrixGenerics}
package (e.g. \code{?MatrixGenerics::\link[MatrixGenerics]{rowVars}})
for a description of these arguments.
}
\item{dims, rows, cols}{
These arguments are not supported. Don't use them.
}
}
\details{
All these operations are block-processed.
}
\seealso{
\itemize{
\item The \pkg{DelayedMatrixStats} package for more row/col summarization
methods for \link{DelayedMatrix} objects.
\item The man pages for the various generic functions defined
in the \pkg{MatrixGenerics} package e.g.
\code{MatrixGenerics::\link[MatrixGenerics]{colVars}} etc...
\item \link{DelayedMatrix-rowsum} for \code{rowsum()} and
\code{colsum()} methods for \link{DelayedMatrix} objects.
\item \link{DelayedMatrix-mult} for DelayedMatrix multiplication
and cross-product.
\item \link{DelayedArray} objects.
}
}
\examples{
library(HDF5Array)
toy_h5 <- system.file("extdata", "toy.h5", package="HDF5Array")
h5ls(toy_h5)
M1 <- HDF5Array(toy_h5, "M1")
M2 <- HDF5Array(toy_h5, "M2")
M12 <- rbind(M1, t(M2)) # delayed
## All these operations are block-processed.
rsums <- rowSums(M12)
csums <- colSums(M12)
rmeans <- rowMeans(M12)
cmeans <- colMeans(M12)
rmins <- rowMins(M12)
cmins <- colMins(M12)
rmaxs <- rowMaxs(M12)
cmaxs <- colMaxs(M12)
rranges <- rowRanges(M12)
cranges <- colRanges(M12)
rvars <- rowVars(M12, center=rmeans)
cvars <- colVars(M12, center=cmeans)
## Sanity checks:
m12 <- rbind(as.matrix(M1), t(as.matrix(M2)))
stopifnot(
identical(rsums, rowSums(m12)),
identical(csums, colSums(m12)),
identical(rmeans, rowMeans(m12)),
identical(cmeans, colMeans(m12)),
identical(rmins, rowMins(m12)),
identical(cmins, colMins(m12)),
identical(rmaxs, rowMaxs(m12)),
identical(cmaxs, colMaxs(m12)),
identical(rranges, cbind(rmins, rmaxs, deparse.level=0)),
identical(cranges, cbind(cmins, cmaxs, deparse.level=0)),
all.equal(rvars, rowVars(m12)),
all.equal(cvars, colVars(m12))
)
}
\keyword{array}
\keyword{methods}
\keyword{algebra}
\keyword{arith}
|
