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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/methods.R, R/methods_row.R
\name{colWeightedVars,xgCMatrix-method}
\alias{colWeightedVars,xgCMatrix-method}
\alias{rowWeightedVars,xgCMatrix-method}
\title{Calculates the weighted variance for each row (column) of a matrix-like
object}
\usage{
\S4method{colWeightedVars}{xgCMatrix}(
x,
w = NULL,
rows = NULL,
cols = NULL,
na.rm = FALSE,
useNames = TRUE
)
\S4method{rowWeightedVars}{xgCMatrix}(
x,
w = NULL,
rows = NULL,
cols = NULL,
na.rm = FALSE,
useNames = TRUE
)
}
\arguments{
\item{x}{An NxK matrix-like object.}
\item{w}{A \code{\link{numeric}} vector of length K (N) that specifies by
how much each element is weighted.}
\item{rows, cols}{A \code{\link{vector}} indicating the subset of rows
(and/or columns) to operate over. If \code{\link{NULL}}, no subsetting is
done.}
\item{na.rm}{If \code{\link[base]{TRUE}}, missing values
(\code{\link[base]{NA}} or \code{\link[base]{NaN}}) are
omitted from the calculations.}
\item{useNames}{If \code{\link{TRUE}} (default), names attributes of result are set. Else if \code{\link{FALSE}}, no naming support is done.}
}
\value{
Returns a \code{\link{numeric}} \code{\link{vector}} of length N (K).
}
\description{
Calculates the weighted variance for each row (column) of a matrix-like
object.
}
\details{
The S4 methods for \code{x} of type \code{\link{matrix}},
\code{\link{array}}, \code{\link{table}}, or \code{\link{numeric}} call
\code{matrixStats::\link[matrixStats]{rowWeightedVars}} /
\code{matrixStats::\link[matrixStats]{colWeightedVars}}.
}
\examples{
mat <- matrix(rnorm(15), nrow = 5, ncol = 3)
mat[2, 1] <- NA
mat[3, 3] <- Inf
mat[4, 1] <- 0
print(mat)
w <- rnorm(n = 5, mean = 3)
rowWeightedVars(mat, w = w[1:3])
colWeightedVars(mat, w = w)
}
\seealso{
\itemize{
\item \code{matrixStats::\link[matrixStats:weightedVar]{rowWeightedVars}()} and
\code{matrixStats::\link[matrixStats:weightedVar]{colWeightedVars}()}
which are used when the input is a \code{matrix} or \code{numeric} vector.
\item See also \link[MatrixGenerics]{rowVars} for the corresponding unweighted function.
}
}
|
