| 1 |
<!DOCTYPE html> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta charset="utf-8"> |
| 5 |
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> |
| 6 |
<title>matrixStats: Summary of functions</title> |
| 7 |
<style type="text/css"> |
| 8 |
body { |
| 9 |
font-family: sans-serif; |
| 10 |
max-width: 800px; |
| 11 |
margin: auto; |
| 12 |
padding: 1em; |
| 13 |
line-height: 1.5; |
| 14 |
box-sizing: border-box; |
| 15 |
} |
| 16 |
body, .footnotes, code { font-size: .9em; } |
| 17 |
li li { font-size: .95em; } |
| 18 |
*, *:before, *:after { |
| 19 |
box-sizing: inherit; |
| 20 |
} |
| 21 |
pre, img { max-width: 100%; } |
| 22 |
pre, pre:hover { |
| 23 |
white-space: pre-wrap; |
| 24 |
word-break: break-all; |
| 25 |
} |
| 26 |
pre code { |
| 27 |
display: block; |
| 28 |
overflow-x: auto; |
| 29 |
} |
| 30 |
code { font-family: 'DejaVu Sans Mono', 'Droid Sans Mono', 'Lucida Console', Consolas, Monaco, monospace; } |
| 31 |
:not(pre) > code, code[class] { background-color: #F8F8F8; } |
| 32 |
code.language-undefined, pre > code:not([class]) { |
| 33 |
background-color: inherit; |
| 34 |
border: 1px solid #eee; |
| 35 |
} |
| 36 |
table { |
| 37 |
margin: auto; |
| 38 |
border-top: 1px solid #666; |
| 39 |
} |
| 40 |
table thead th { border-bottom: 1px solid #ddd; } |
| 41 |
th, td { padding: 5px; } |
| 42 |
thead, tfoot, tr:nth-child(even) { background: #eee; } |
| 43 |
blockquote { |
| 44 |
color: #666; |
| 45 |
margin: 0; |
| 46 |
padding-left: 1em; |
| 47 |
border-left: 0.5em solid #eee; |
| 48 |
} |
| 49 |
hr, .footnotes::before { border: 1px dashed #ddd; } |
| 50 |
.frontmatter { text-align: center; } |
| 51 |
#TOC .numbered li { list-style: none; } |
| 52 |
#TOC .numbered { padding-left: 0; } |
| 53 |
#TOC .numbered ul { padding-left: 1em; } |
| 54 |
table, .body h2 { border-bottom: 1px solid #666; } |
| 55 |
.body .appendix, .appendix ~ h2 { border-bottom-style: dashed; } |
| 56 |
.footnote-ref a::before { content: "["; } |
| 57 |
.footnote-ref a::after { content: "]"; } |
| 58 |
section.footnotes::before { |
| 59 |
content: ""; |
| 60 |
display: block; |
| 61 |
max-width: 20em; |
| 62 |
} |
| 63 |
|
| 64 |
@media print { |
| 65 |
body { |
| 66 |
font-size: 12pt; |
| 67 |
max-width: 100%; |
| 68 |
} |
| 69 |
tr, img { page-break-inside: avoid; } |
| 70 |
} |
| 71 |
@media only screen and (min-width: 992px) { |
| 72 |
pre { white-space: pre; } |
| 73 |
} |
| 74 |
</style> |
| 75 |
<meta name="keywords" content="matrix, vector, apply, rows, columns, memory, speed"> |
| 76 |
<meta name="author" content="Henrik Bengtsson"> |
| 77 |
</head> |
| 78 |
<body> |
| 79 |
<div class="frontmatter"> |
| 80 |
<div class="title"><h1>matrixStats: Summary of functions</h1></div> |
| 81 |
<div class="author"><h2></h2></div> |
| 82 |
<div class="date"><h3></h3></div> |
| 83 |
</div> |
| 84 |
<div class="body"> |
| 85 |
<h1 id="matrixstats-summary-of-functions">matrixStats: Summary of functions</h1> |
| 86 |
<p>Henrik Bengtsson on NA</p> |
| 87 |
<h2 id="location-and-scale-estimators">Location and scale estimators</h2> |
| 88 |
<table> |
| 89 |
<thead> |
| 90 |
<tr> |
| 91 |
<th align="left">Estimator</th> |
| 92 |
<th align="left">Functions</th> |
| 93 |
<th align="left">Example</th> |
| 94 |
</tr> |
| 95 |
</thead> |
| 96 |
<tbody> |
| 97 |
<tr> |
| 98 |
<td align="left">Weighted sample mean</td> |
| 99 |
<td align="left">weightedMean(), colWeightedMeans(), rowWeightedMeans()</td> |
| 100 |
<td align="left"><code>weightedMean(x, w); rowWeightedMeans(x, w)</code></td> |
| 101 |
</tr> |
| 102 |
<tr> |
| 103 |
<td align="left">Mean</td> |
| 104 |
<td align="left">mean2(), colMeans2(), rowMeans2()</td> |
| 105 |
<td align="left"><code>mean2(x); rowMeans2(x)</code></td> |
| 106 |
</tr> |
| 107 |
<tr> |
| 108 |
<td align="left">Median</td> |
| 109 |
<td align="left">median(), colMedians(), rowMedians()</td> |
| 110 |
<td align="left"><code>median(x); rowMedians(x)</code></td> |
| 111 |
</tr> |
| 112 |
<tr> |
| 113 |
<td align="left">Weighted median</td> |
| 114 |
<td align="left">weightedMedian(), colWeightedMedians(), rowWeightedMedians()</td> |
| 115 |
<td align="left"><code>weightedMedian(x, w); rowWeightedMedians(x, w)</code></td> |
| 116 |
</tr> |
| 117 |
<tr> |
| 118 |
<td align="left">Sample variance</td> |
| 119 |
<td align="left">var(), colVars(), rowVars()</td> |
| 120 |
<td align="left"><code>var(x); rowVars(x)</code></td> |
| 121 |
</tr> |
| 122 |
<tr> |
| 123 |
<td align="left">Weighted sample variance</td> |
| 124 |
<td align="left">weightedVar(), colWeightedVars(), rowWeightedVars()</td> |
| 125 |
<td align="left"><code>weightedVar(x, w), rowWeightedVars(x, w)</code></td> |
| 126 |
</tr> |
| 127 |
<tr> |
| 128 |
<td align="left">Sample variance by n-order differences</td> |
| 129 |
<td align="left">varDiff(), colVarDiffs(), rowVarDiffs()</td> |
| 130 |
<td align="left"><code>varDiff(x); rowVarDiffs(x)</code></td> |
| 131 |
</tr> |
| 132 |
<tr> |
| 133 |
<td align="left">Sample standard deviation</td> |
| 134 |
<td align="left">sd(), colSds(), rowSds()</td> |
| 135 |
<td align="left"><code>sd(x); rowSds(x)</code></td> |
| 136 |
</tr> |
| 137 |
<tr> |
| 138 |
<td align="left">Weighted sample deviation</td> |
| 139 |
<td align="left">weightedSd(), colWeightedSds(), rowWeightedSds()</td> |
| 140 |
<td align="left"><code>weightedSd(x, w), rowWeightedSds(x, w)</code></td> |
| 141 |
</tr> |
| 142 |
<tr> |
| 143 |
<td align="left">Sample standard deviation by n-order differences</td> |
| 144 |
<td align="left">sdDiff(), colSdDiffs(), rowSdDiffs()</td> |
| 145 |
<td align="left"><code>sdDiff(x); rowSdDiffs(x)</code></td> |
| 146 |
</tr> |
| 147 |
<tr> |
| 148 |
<td align="left">Median absolute deviation (MAD)</td> |
| 149 |
<td align="left">mad(), colMads(), rowMads()</td> |
| 150 |
<td align="left"><code>mad(x); rowMads(x)</code></td> |
| 151 |
</tr> |
| 152 |
<tr> |
| 153 |
<td align="left">Weighted median absolute deviation (MAD)</td> |
| 154 |
<td align="left">weightedMad(), colWeightedMads(), rowWeightedMads()</td> |
| 155 |
<td align="left"><code>weightedMad(x, w), rowWeightedMads(x, w)</code></td> |
| 156 |
</tr> |
| 157 |
<tr> |
| 158 |
<td align="left">Median absolute deviation (MAD) by n-order differences</td> |
| 159 |
<td align="left">madDiff(), colMadDiffs(), rowMadDiffs()</td> |
| 160 |
<td align="left"><code>madDiff(x); rowMadDiffs()</code></td> |
| 161 |
</tr> |
| 162 |
<tr> |
| 163 |
<td align="left">Quantile</td> |
| 164 |
<td align="left">quantile(), colQuantiles(), rowQuantiles()</td> |
| 165 |
<td align="left"><code>quantile(x, probs); rowQuantiles(x, probs)</code></td> |
| 166 |
</tr> |
| 167 |
<tr> |
| 168 |
<td align="left">Interquartile range (IQR)</td> |
| 169 |
<td align="left">iqr(), colIQRs(), rowIQRs()</td> |
| 170 |
<td align="left"><code>iqr(x); rowIQRs(x)</code></td> |
| 171 |
</tr> |
| 172 |
<tr> |
| 173 |
<td align="left">Interquartile range (IQR) by n-order differences</td> |
| 174 |
<td align="left">iqrDiff(), colIQRDiffs(), rowIQRDiffs()</td> |
| 175 |
<td align="left"><code>iqrDiff(x); rowIQRDiffs(x)</code></td> |
| 176 |
</tr> |
| 177 |
<tr> |
| 178 |
<td align="left">Range</td> |
| 179 |
<td align="left">range(), colRanges(), rowRanges()</td> |
| 180 |
<td align="left"><code>range(x); rowRanges(x)</code></td> |
| 181 |
</tr> |
| 182 |
<tr> |
| 183 |
<td align="left">Minimum</td> |
| 184 |
<td align="left">min(), colMins(), rowMins()</td> |
| 185 |
<td align="left"><code>min(x); rowMins(x)</code></td> |
| 186 |
</tr> |
| 187 |
<tr> |
| 188 |
<td align="left">Maximum</td> |
| 189 |
<td align="left">max(), colMaxs(), rowMaxs()</td> |
| 190 |
<td align="left"><code>max(x); rowMaxs(x)</code></td> |
| 191 |
</tr> |
| 192 |
</tbody> |
| 193 |
</table> |
| 194 |
<h2 id="testing-for-and-counting-values">Testing for and counting values</h2> |
| 195 |
<table> |
| 196 |
<thead> |
| 197 |
<tr> |
| 198 |
<th align="left">Operator</th> |
| 199 |
<th align="left">Functions</th> |
| 200 |
<th align="left">Example</th> |
| 201 |
</tr> |
| 202 |
</thead> |
| 203 |
<tbody> |
| 204 |
<tr> |
| 205 |
<td align="left">Are there any missing values?</td> |
| 206 |
<td align="left">anyMissing(), colAnyMissings(), rowAnyMissings()</td> |
| 207 |
<td align="left"><code>anyMissing(x); rowAnyMissings(x)</code></td> |
| 208 |
</tr> |
| 209 |
<tr> |
| 210 |
<td align="left">Does TRUE exists?</td> |
| 211 |
<td align="left">any(), colAnys(), rowAnys()</td> |
| 212 |
<td align="left"><code>any(x); rowAnys(x)</code></td> |
| 213 |
</tr> |
| 214 |
<tr> |
| 215 |
<td align="left">Are all values TRUE?</td> |
| 216 |
<td align="left">all(), colAlls(), rowAlls()</td> |
| 217 |
<td align="left"><code>all(x); rowAlls(x)</code></td> |
| 218 |
</tr> |
| 219 |
<tr> |
| 220 |
<td align="left">Does value exists?</td> |
| 221 |
<td align="left">anyValue(), colAnys(), rowAnys()</td> |
| 222 |
<td align="left"><code>anyValue(x, value); rowAnys(x, value)</code></td> |
| 223 |
</tr> |
| 224 |
<tr> |
| 225 |
<td align="left">Do all elements have a given value?</td> |
| 226 |
<td align="left">allValue(), colAlls(), rowAlls()</td> |
| 227 |
<td align="left"><code>allValue(x, value); rowAlls(x, value)</code></td> |
| 228 |
</tr> |
| 229 |
<tr> |
| 230 |
<td align="left">Number of occurrences of a value?</td> |
| 231 |
<td align="left">count(), colCounts(), rowCounts()</td> |
| 232 |
<td align="left"><code>count(x, value); rowCounts(x, value)</code></td> |
| 233 |
</tr> |
| 234 |
</tbody> |
| 235 |
</table> |
| 236 |
<h2 id="cumulative-functions">Cumulative functions</h2> |
| 237 |
<table> |
| 238 |
<thead> |
| 239 |
<tr> |
| 240 |
<th align="left">Operator</th> |
| 241 |
<th align="left">Functions</th> |
| 242 |
<th align="left">Example</th> |
| 243 |
</tr> |
| 244 |
</thead> |
| 245 |
<tbody> |
| 246 |
<tr> |
| 247 |
<td align="left">Cumulative sum</td> |
| 248 |
<td align="left">cumsum(), colCumsums(), rowCumsums()</td> |
| 249 |
<td align="left"><code>cumsum(x); rowCumsums(x)</code></td> |
| 250 |
</tr> |
| 251 |
<tr> |
| 252 |
<td align="left">Cumulative product</td> |
| 253 |
<td align="left">cumprod(), colCumprods(), rowCumprods()</td> |
| 254 |
<td align="left"><code>cumprod(x); rowCumprods(x)</code></td> |
| 255 |
</tr> |
| 256 |
<tr> |
| 257 |
<td align="left">Cumulative minimum</td> |
| 258 |
<td align="left">cummin(), colCummins(), rowCummins()</td> |
| 259 |
<td align="left"><code>cummin(x); rowCummins(x)</code></td> |
| 260 |
</tr> |
| 261 |
<tr> |
| 262 |
<td align="left">Cumulative maximum</td> |
| 263 |
<td align="left">cummax(), colCummaxs(), rowCummaxs()</td> |
| 264 |
<td align="left"><code>cummax(x); rowCummaxs(x)</code></td> |
| 265 |
</tr> |
| 266 |
</tbody> |
| 267 |
</table> |
| 268 |
<h2 id="binning">Binning</h2> |
| 269 |
<table> |
| 270 |
<thead> |
| 271 |
<tr> |
| 272 |
<th align="left">Estimator</th> |
| 273 |
<th align="left">Functions</th> |
| 274 |
<th align="left">Example</th> |
| 275 |
</tr> |
| 276 |
</thead> |
| 277 |
<tbody> |
| 278 |
<tr> |
| 279 |
<td align="left">Counts in disjoint bins</td> |
| 280 |
<td align="left">binCounts()</td> |
| 281 |
<td align="left"><code>binCounts(x, bx)</code></td> |
| 282 |
</tr> |
| 283 |
<tr> |
| 284 |
<td align="left">Sample means (and counts) in disjoint bins</td> |
| 285 |
<td align="left">binMeans()</td> |
| 286 |
<td align="left"><code>binMeans(y, x, bx)</code></td> |
| 287 |
</tr> |
| 288 |
</tbody> |
| 289 |
</table> |
| 290 |
<h2 id="miscellaneous">Miscellaneous</h2> |
| 291 |
<table> |
| 292 |
<thead> |
| 293 |
<tr> |
| 294 |
<th align="left">Operation</th> |
| 295 |
<th align="left">Functions</th> |
| 296 |
<th align="left">Example</th> |
| 297 |
</tr> |
| 298 |
</thead> |
| 299 |
<tbody> |
| 300 |
<tr> |
| 301 |
<td align="left">Sum</td> |
| 302 |
<td align="left">sum2(), colSums2(), rowSums2()</td> |
| 303 |
<td align="left"><code>sum2(x); rowSums2(x)</code></td> |
| 304 |
</tr> |
| 305 |
<tr> |
| 306 |
<td align="left">Lagged differences</td> |
| 307 |
<td align="left">diff2(), colDiffs(), rowDiffs()</td> |
| 308 |
<td align="left"><code>diff2(x), rowDiffs(x)</code></td> |
| 309 |
</tr> |
| 310 |
</tbody> |
| 311 |
</table> |
| 312 |
<hr /> |
| 313 |
<p>matrixStats v1.5.0. Release: <a href="https://cran.r-project.org/package=matrixStats">CRAN</a>, Development: <a href="https://github.com/HenrikBengtsson/matrixStats">GitHub</a>.</p> |
| 314 |
</div> |
| 315 |
</body> |
| 316 |
</html> |