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
|
\name{NaArray-matrixStats}
\alias{NaArray-matrixStats}
\alias{NaArray_matrixStats}
\alias{colAnyNAs,NaArray-method}
\alias{rowAnyNAs,NaArray-method}
\alias{colAnys,NaArray-method}
\alias{colAlls,NaArray-method}
\alias{colMins,NaArray-method}
\alias{rowMins,NaArray-method}
\alias{colMaxs,NaArray-method}
\alias{rowMaxs,NaArray-method}
\alias{colRanges,NaArray-method}
\alias{rowRanges,NaArray-method}
\alias{colSums,NaArray-method}
\alias{rowSums,NaArray-method}
\alias{colProds,NaArray-method}
\alias{colMeans,NaArray-method}
\alias{colSums2,NaArray-method}
\alias{rowSums2,NaArray-method}
\alias{colMeans2,NaArray-method}
\alias{colVars,NaArray-method}
\alias{colSds,NaArray-method}
\title{NaArray col/row summarization}
\description{
EXPERIMENTAL!!!
The \pkg{SparseArray} package provides memory-efficient col/row
summarization methods (a.k.a. matrixStats methods) for \link{NaArray}
objects, like \code{colSums()}, \code{rowSums()}, \code{colMeans()},
\code{rowMeans()}, etc...
Note that these are \emph{S4 generic functions} defined in the
\pkg{MatrixGenerics} package, with methods for ordinary matrices
defined in the \pkg{matrixStats} package. This man page documents
the methods defined for \link{NaArray} objects.
IMPORTANT NOTE: This is WORK-IN-PROGRESS! All the \code{col*()} methods
listed below are supported. However, among the \code{row*()} methods,
only \code{rowAnyNAs()}, \code{rowMins()}, \code{rowMaxs()},
\code{rowRanges()}, \code{rowSums()}, and \code{rowSums2()} are
supported on \link{NaArray} objects at the moment.
}
\usage{
## N.B.: Showing ONLY the col*() methods (usage of row*() methods is
## the same):
\S4method{colAnyNAs}{NaArray}(x, rows=NULL, cols=NULL, dims=1, ..., useNames=NA)
\S4method{colAnys}{NaArray}(x, rows=NULL, cols=NULL, na.rm=FALSE, dims=1, ..., useNames=NA)
\S4method{colAlls}{NaArray}(x, rows=NULL, cols=NULL, na.rm=FALSE, dims=1, ..., useNames=NA)
\S4method{colMins}{NaArray}(x, rows=NULL, cols=NULL, na.rm=FALSE, dims=1, ..., useNames=NA)
\S4method{colMaxs}{NaArray}(x, rows=NULL, cols=NULL, na.rm=FALSE, dims=1, ..., useNames=NA)
\S4method{colRanges}{NaArray}(x, rows=NULL, cols=NULL, na.rm=FALSE, dims=1, ..., useNames=NA)
\S4method{colSums}{NaArray}(x, na.rm=FALSE, dims=1)
\S4method{colProds}{NaArray}(x, rows=NULL, cols=NULL, na.rm=FALSE, dims=1, ..., useNames=NA)
\S4method{colMeans}{NaArray}(x, na.rm=FALSE, dims=1)
\S4method{colSums2}{NaArray}(x, rows=NULL, cols=NULL, na.rm=FALSE, dims=1, ..., useNames=NA)
\S4method{colMeans2}{NaArray}(x, rows=NULL, cols=NULL, na.rm=FALSE, dims=1, ..., useNames=NA)
\S4method{colVars}{NaArray}(x, rows=NULL, cols=NULL, na.rm=FALSE, center=NULL, dims=1,
..., useNames=NA)
\S4method{colSds}{NaArray}(x, rows=NULL, cols=NULL, na.rm=FALSE, center=NULL, dims=1,
..., useNames=NA)
}
\arguments{
\item{x}{
An \link{NaMatrix} or \link{NaArray} object.
}
\item{rows, cols, ...}{
Not supported.
}
\item{na.rm, useNames, center}{
See man pages of the corresponding generics in the \pkg{MatrixGenerics}
package (e.g. \code{?MatrixGenerics::\link[MatrixGenerics]{colVars}})
for a description of these arguments.
Note that, unlike the methods for ordinary matrices defined in
the \pkg{matrixStats} package, the \code{center} argument of the
\code{colVars()}, \code{rowVars()}, \code{colSds()}, and \code{rowSds()}
methods for \link{SparseArray} objects can only be a
\emph{single value} (or a \code{NULL}). In particular, if \code{x}
has more than one column, then \code{center} cannot be a vector
with one value per column in \code{x}.
}
\item{dims}{
See \code{?base::\link[base]{colSums}} for a description of this
argument.
}
}
\details{
These methods are typically used with \code{na.rm=TRUE} when called
on an \link{NaMatrix} or \link{NaArray} object.
All these methods operate \emph{natively} on the \link{NaArray}
internal representation, for maximum efficiency.
Note that more col/row summarization methods might be added in the future.
}
\value{
See man pages of the corresponding generics in the \pkg{MatrixGenerics}
package (e.g. \code{?MatrixGenerics::\link[MatrixGenerics]{colRanges}})
for the value returned by these methods.
}
\note{
Most \code{col*()} methods for \link{NaArray} objects are multithreaded.
See \code{\link{set_SparseArray_nthread}} for how to control the number
of threads.
}
\seealso{
\itemize{
\item \link{NaArray} objects.
\item The man pages of the various generic functions defined
in the \pkg{MatrixGenerics} package e.g.
\code{MatrixGenerics::\link[MatrixGenerics]{colVars}} etc...
}
}
\examples{
# COMING SOON...
}
\keyword{array}
\keyword{methods}
\keyword{algebra}
\keyword{arith}
|
