doc neaten

johnkerl · Jan 11, 2016 · 4db9524 · 4db9524
1 parent 1ea3c6b
commit 4db9524
Show file tree

Hide file tree

Showing 2 changed files with 88 additions and 0 deletions.
diff --git a/doc/content-for-reference.html b/doc/content-for-reference.html
@@ -331,6 +331,50 @@ <h2>bootstrap</h2>
 
 POKI_RUN_COMMAND{{mlr bootstrap --help}}HERE
 
+<p/> The canonical use for bootstrap sampling is to put error bars on statistical quantities, such as mean. For example:
+
+<p/>
+<div class="pokipanel">
+<pre>
+$ mlr --opprint stats1 -a mean,count -f u -g color data/colored-shapes.dkvp 
+color  u_mean   u_count
+yellow 0.497129 1413
+red    0.492560 4641
+purple 0.494005 1142
+green  0.504861 1109
+blue   0.517717 1470
+orange 0.490532 303
+
+$ mlr --opprint bootstrap then stats1 -a mean,count -f u -g color data/colored-shapes.dkvp 
+color  u_mean   u_count
+yellow 0.500651 1380
+purple 0.501556 1111
+green  0.503272 1068
+red    0.493895 4702
+blue   0.512529 1496
+orange 0.521030 321
+
+$ mlr --opprint bootstrap then stats1 -a mean,count -f u -g color data/colored-shapes.dkvp 
+color  u_mean   u_count
+yellow 0.498046 1485
+blue   0.513576 1417
+red    0.492870 4595
+orange 0.507697 307
+green  0.496803 1075
+purple 0.486337 1199
+
+$ mlr --opprint bootstrap then stats1 -a mean,count -f u -g color data/colored-shapes.dkvp 
+color  u_mean   u_count
+blue   0.522921 1447
+red    0.490717 4617
+yellow 0.496450 1419
+purple 0.496523 1192
+green  0.507569 1111
+orange 0.468014 292
+</pre>
+</div>
+<p/>
+
 <!-- ================================================================ -->
 <h2>cat</h2>
 

diff --git a/doc/reference.html b/doc/reference.html
@@ -925,6 +925,50 @@
 </div>
 <p/>
 
+<p/> The canonical use for bootstrap sampling is to put error bars on statistical quantities, such as mean. For example:
+
+<p/>
+<div class="pokipanel">
+<pre>
+$ mlr --opprint stats1 -a mean,count -f u -g color data/colored-shapes.dkvp 
+color  u_mean   u_count
+yellow 0.497129 1413
+red    0.492560 4641
+purple 0.494005 1142
+green  0.504861 1109
+blue   0.517717 1470
+orange 0.490532 303
+
+$ mlr --opprint bootstrap then stats1 -a mean,count -f u -g color data/colored-shapes.dkvp 
+color  u_mean   u_count
+yellow 0.500651 1380
+purple 0.501556 1111
+green  0.503272 1068
+red    0.493895 4702
+blue   0.512529 1496
+orange 0.521030 321
+
+$ mlr --opprint bootstrap then stats1 -a mean,count -f u -g color data/colored-shapes.dkvp 
+color  u_mean   u_count
+yellow 0.498046 1485
+blue   0.513576 1417
+red    0.492870 4595
+orange 0.507697 307
+green  0.496803 1075
+purple 0.486337 1199
+
+$ mlr --opprint bootstrap then stats1 -a mean,count -f u -g color data/colored-shapes.dkvp 
+color  u_mean   u_count
+blue   0.522921 1447
+red    0.490717 4617
+yellow 0.496450 1419
+purple 0.496523 1192
+green  0.507569 1111
+orange 0.468014 292
+</pre>
+</div>
+<p/>
+
 <!-- ================================================================ -->
 <a id="cat"/><h2>cat</h2>