Skip to content

Commit

Permalink
Updated the readme and manual
Browse files Browse the repository at this point in the history
  • Loading branch information
acp29 committed Feb 20, 2024
1 parent 2543f73 commit 75f514c
Show file tree
Hide file tree
Showing 26 changed files with 141 additions and 129 deletions.
20 changes: 13 additions & 7 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,11 @@ <h3 id="using-the-statistics-resampling-package-online">Using the
<a
href="https://mybinder.org/v2/gh/acpennlab/statistics-resampling-online/master?labpath=statistics-resampling.ipynb"><img
src="https://mybinder.org/badge_logo.svg" alt="Binder" /></a>: a
ready-to-go implementation of statistics-resampling a Jupyter Notebook
with an Octave kernel. <em>Note that the first time you use
statistics-resampling online in Octave with Binder you can expect it to
take a few minutes to build a docker image.</em></p>
ready-to-go implementation of statistics-resampling in a JupyterLab
Notebook with an Octave kernel. <em>Note that the first time (since the
last repository commit) that you use statistics-resampling online with
Binder you can expect it to take a few minutes to build a docker
image.</em></p>
<p>Collaborative student projects in GNU Octave can use the
statistics-resampling package at <a
href="https://octave-online.net/">Octave-Online</a>. Doing so requires
Expand Down Expand Up @@ -219,9 +220,14 @@ <h3 id="quick-start">Quick start</h3>
sample size calculations for a two-sample test with nested
design</a></p></li>
</ul>
<p>For an example of how to import (larger) data sets from a
human-readable text file, like a comma-separated-value (CSV) file, see
the last demonstration listed on <a
<p>For examples of how to import data sets from a human-readable text
file, like a tab-separated-value (TSV) and comma-separated-value (CSV)
file, see the examples in the JupyterLab Notebook at <a
href="https://mybinder.org/v2/gh/acpennlab/statistics-resampling-online/master?labpath=statistics-resampling.ipynb">statistics-resampling-online</a>
<a
href="https://mybinder.org/v2/gh/acpennlab/statistics-resampling-online/master?labpath=statistics-resampling.ipynb"><img
src="https://mybinder.org/badge_logo.svg" alt="Binder" /></a> and the
last demonstration listed on <a
href="https://gnu-octave.github.io/statistics-resampling/function/randtest2.html#5">this
page</a></p>
<h3 id="issues">Issues</h3>
Expand Down
2 changes: 1 addition & 1 deletion docs/copying.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="date" content="2024-02-18"/>
<meta name="date" content="2024-02-20"/>
<meta name="generator" content="generate_html 0.3.3" />
<meta name="author" content="Andrew Penn" />
<meta name="description" content="A package for statistical analysis using resampling methods." />
Expand Down
2 changes: 1 addition & 1 deletion docs/description.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"generator": "generate_html",
"generator_version": "0.3.3",
"date_generated": "2024-02-18",
"date_generated": "2024-02-20",
"package":
{
"name": "statistics-resampling",
Expand Down
2 changes: 1 addition & 1 deletion docs/function/boot.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="date" content="2024-02-18"/>
<meta name="date" content="2024-02-20"/>
<meta name="generator" content="generate_html 0.3.3" />
<meta name="author" content="Andrew Penn" />
<meta name="description" content="A package for statistical analysis using resampling methods." />
Expand Down
6 changes: 3 additions & 3 deletions docs/function/boot1way.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="date" content="2024-02-18"/>
<meta name="date" content="2024-02-20"/>
<meta name="generator" content="generate_html 0.3.3" />
<meta name="author" content="Andrew Penn" />
<meta name="description" content="A package for statistical analysis using resampling methods." />
Expand Down Expand Up @@ -529,7 +529,7 @@ <h3><a name="7">Demonstration 7</a></h3>
-----------------------------------------------------------------------------
| Comparison | Test # | Ref # | Difference | t | p |
|------------|------------|------------|------------|------------|----------|
| 1 | 2 | 1 | +0.9092 | +1.70 | .126 |
| 1 | 2 | 1 | +0.1148 | +0.19 | .844 |

-----------------------------------------------------------------------------
| GROUP # | GROUP label | N |
Expand Down Expand Up @@ -574,7 +574,7 @@ <h3><a name="8">Demonstration 8</a></h3>
-----------------------------------------------------------------------------
| Comparison | Test # | Ref # | Difference | t | p |
|------------|------------|------------|------------|------------|----------|
| 1 | 2 | 1 | +0.03248 | +0.04 | .943 |
| 1 | 2 | 1 | -0.5577 | -0.57 | .465 |

-----------------------------------------------------------------------------
| GROUP # | GROUP label | N |
Expand Down
8 changes: 4 additions & 4 deletions docs/function/bootbayes.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="date" content="2024-02-18"/>
<meta name="date" content="2024-02-20"/>
<meta name="generator" content="generate_html 0.3.3" />
<meta name="author" content="Andrew Penn" />
<meta name="description" content="A package for statistical analysis using resampling methods." />
Expand Down Expand Up @@ -191,7 +191,7 @@ <h3><a name="1">Demonstration 1</a></h3>

Posterior Statistics:
original bias median stdev CI_lower CI_upper
+184.5 +0.02861 +184.5 1.293 +182.1 +187.2</pre>
+184.5 -0.02210 +184.5 1.240 +182.1 +186.9</pre>
</div>

<h3><a name="2">Demonstration 2</a></h3>
Expand Down Expand Up @@ -228,8 +228,8 @@ <h3><a name="2">Demonstration 2</a></h3>

Posterior Statistics:
original bias median stdev CI_lower CI_upper
+175.5 -0.08181 +175.4 2.404 +170.7 +180.1
+0.1904 +0.001776 +0.1926 0.07978 +0.03726 +0.3460</pre>
+175.5 +0.03532 +175.5 2.384 +171.1 +180.3
+0.1904 -0.001074 +0.1909 0.07912 +0.04160 +0.3442</pre>
</div>

<p>Package: <a href="../index.html">statistics-resampling</a></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/function/bootcdf.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="date" content="2024-02-18"/>
<meta name="date" content="2024-02-20"/>
<meta name="generator" content="generate_html 0.3.3" />
<meta name="author" content="Andrew Penn" />
<meta name="description" content="A package for statistical analysis using resampling methods." />
Expand Down
2 changes: 1 addition & 1 deletion docs/function/bootci.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="date" content="2024-02-18"/>
<meta name="date" content="2024-02-20"/>
<meta name="generator" content="generate_html 0.3.3" />
<meta name="author" content="Andrew Penn" />
<meta name="description" content="A package for statistical analysis using resampling methods." />
Expand Down
30 changes: 15 additions & 15 deletions docs/function/bootclust.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="date" content="2024-02-18"/>
<meta name="date" content="2024-02-20"/>
<meta name="generator" content="generate_html 0.3.3" />
<meta name="author" content="Andrew Penn" />
<meta name="description" content="A package for statistical analysis using resampling methods." />
Expand Down Expand Up @@ -174,7 +174,7 @@ <h3><a name="1">Demonstration 1</a></h3>

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+29.65 -4.619e-14 +2.614 +23.45 +34.51</pre>
+29.65 -4.263e-14 +2.546 +23.58 +34.50</pre>
</div>

<h3><a name="2">Demonstration 2</a></h3>
Expand Down Expand Up @@ -204,7 +204,7 @@ <h3><a name="2">Demonstration 2</a></h3>

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+29.65 -0.03435 +2.909 +22.40 +35.62</pre>
+29.65 -0.04092 +2.935 +22.61 +35.83</pre>
</div>

<h3><a name="3">Demonstration 3</a></h3>
Expand Down Expand Up @@ -232,7 +232,7 @@ <h3><a name="3">Demonstration 3</a></h3>

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -6.674 +41.84 +97.53 +235.5</pre>
+171.5 -6.491 +40.86 +99.28 +234.9</pre>
</div>

<h3><a name="4">Demonstration 4</a></h3>
Expand Down Expand Up @@ -262,7 +262,7 @@ <h3><a name="4">Demonstration 4</a></h3>

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -9.522 +33.81 +103.5 +215.0</pre>
+171.5 -9.145 +32.96 +105.8 +215.0</pre>
</div>

<h3><a name="5">Demonstration 5</a></h3>
Expand All @@ -285,11 +285,11 @@ <h3><a name="5">Demonstration 5</a></h3>
Resampling method: Balanced, bootstrap cluster resampling
Number of resamples: 1999
Confidence interval (CI) type: Bias-corrected and accelerated (BCa)
Nominal coverage (and the percentiles used): 90% (12.3%, 98.7%)
Nominal coverage (and the percentiles used): 90% (12.7%, 98.8%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -6.312 +41.84 +116.9 +263.9</pre>
+171.5 -6.336 +40.80 +118.7 +262.9</pre>
</div>

<h3><a name="6">Demonstration 6</a></h3>
Expand All @@ -314,11 +314,11 @@ <h3><a name="6">Demonstration 6</a></h3>
Resampling method: Balanced, bootstrap cluster resampling
Number of resamples: 1999
Confidence interval (CI) type: Bias-corrected and accelerated (BCa)
Nominal coverage (and the percentiles used): 90% (14.2%, 98.9%)
Nominal coverage (and the percentiles used): 90% (12.9%, 98.7%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -9.624 +33.37 +125.3 +231.5</pre>
+171.5 -9.570 +32.89 +123.5 +229.9</pre>
</div>

<h3><a name="7">Demonstration 7</a></h3>
Expand All @@ -344,8 +344,8 @@ <h3><a name="7">Demonstration 7</a></h3>

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
-0.1236 +3.489e-05 +0.2123 -0.4434 +0.2593
-0.2114 +0.01794 +0.1991 -0.4872 +0.1585</pre>
+0.3965 +0.02430 +0.2575 -0.04019 +0.7941
+0.005570 -0.04574 +0.2760 -0.4817 +0.3911</pre>
</div>

<h3><a name="8">Demonstration 8</a></h3>
Expand All @@ -372,8 +372,8 @@ <h3><a name="8">Demonstration 8</a></h3>

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+0.05012 +0.01905 +0.08608 -0.08117 +0.1758
+0.09245 -0.02544 +0.2722 -0.3105 +0.5975</pre>
-0.2356 -0.03324 +0.1505 -0.4467 +0.02341
-0.06405 +0.002349 +0.1618 -0.3414 +0.1897</pre>
</div>

<h3><a name="9">Demonstration 9</a></h3>
Expand All @@ -400,11 +400,11 @@ <h3><a name="9">Demonstration 9</a></h3>
Resampling method: Balanced, bootstrap cluster resampling
Number of resamples: 1999
Confidence interval (CI) type: Bias-corrected and accelerated (BCa)
Nominal coverage (and the percentiles used): 95% (1.6%, 96.4%)
Nominal coverage (and the percentiles used): 95% (2.0%, 97.0%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+0.7764 -0.02525 +0.1489 +0.3673 +0.9946</pre>
+0.7764 -0.02542 +0.1443 +0.4041 +0.9975</pre>
</div>

<p>Package: <a href="../index.html">statistics-resampling</a></p>
Expand Down
50 changes: 25 additions & 25 deletions docs/function/bootknife.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="date" content="2024-02-18"/>
<meta name="date" content="2024-02-20"/>
<meta name="generator" content="generate_html 0.3.3" />
<meta name="author" content="Andrew Penn" />
<meta name="description" content="A package for statistical analysis using resampling methods." />
Expand Down Expand Up @@ -223,11 +223,11 @@ <h3><a name="1">Demonstration 1</a></h3>
Number of resamples (outer): 1999
Number of resamples (inner): 0
Confidence interval (CI) type: Expanded bias-corrected and accelerated (BCa)
Nominal coverage (and the percentiles used): 95% (1.3%, 97.2%)
Nominal coverage (and the percentiles used): 95% (1.2%, 96.9%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+29.65 +6.040e-14 +2.574 +23.82 +34.39</pre>
+29.65 -1.421e-14 +2.625 +23.38 +34.36</pre>
</div>

<h3><a name="2">Demonstration 2</a></h3>
Expand All @@ -253,11 +253,11 @@ <h3><a name="2">Demonstration 2</a></h3>
Number of resamples (outer): 1999
Number of resamples (inner): 199
Confidence interval (CI) type: Calibrated percentile
Nominal coverage (and the percentiles used): 95% (1.2%, 97.2%)
Nominal coverage (and the percentiles used): 95% (0.9%, 97.5%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+29.65 +8.527e-14 +2.732 +23.66 +34.62</pre>
+29.65 -7.105e-15 +2.824 +23.09 +34.88</pre>
</div>

<h3><a name="3">Demonstration 3</a></h3>
Expand All @@ -284,11 +284,11 @@ <h3><a name="3">Demonstration 3</a></h3>
Number of resamples (outer): 1999
Number of resamples (inner): 199
Confidence interval (CI) type: Calibrated percentile
Nominal coverage (and the percentiles used): 95% (2.1%, 97.7%)
Nominal coverage (and the percentiles used): 95% (2.1%, 98.2%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+30.86 -0.02952 +2.993 +24.64 +36.89</pre>
+30.86 -0.02395 +2.949 +24.80 +37.16</pre>
</div>

<h3><a name="4">Demonstration 4</a></h3>
Expand Down Expand Up @@ -317,7 +317,7 @@ <h3><a name="4">Demonstration 4</a></h3>

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -6.779 +43.14 +96.63 +237.1</pre>
+171.5 -6.948 +42.58 +96.24 +235.4</pre>
</div>

<h3><a name="5">Demonstration 5</a></h3>
Expand All @@ -341,11 +341,11 @@ <h3><a name="5">Demonstration 5</a></h3>
Number of resamples (outer): 1999
Number of resamples (inner): 0
Confidence interval (CI) type: Bias-corrected and accelerated (BCa)
Nominal coverage (and the percentiles used): 90% (12.3%, 98.7%)
Nominal coverage (and the percentiles used): 90% (12.8%, 98.8%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -6.756 +42.38 +115.0 +265.1</pre>
+171.5 -7.202 +42.45 +115.4 +263.1</pre>
</div>

<h3><a name="6">Demonstration 6</a></h3>
Expand All @@ -372,11 +372,11 @@ <h3><a name="6">Demonstration 6</a></h3>
Number of resamples (outer): 1999
Number of resamples (inner): 199
Confidence interval (CI) type: Calibrated percentile (equal-tailed)
Nominal coverage (and the percentiles used): 90% (2.8%, 97.2%)
Nominal coverage (and the percentiles used): 90% (2.2%, 97.8%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -6.719 +44.49 +86.95 +252.5</pre>
+171.5 -6.716 +43.13 +87.19 +256.2</pre>
</div>

<h3><a name="7">Demonstration 7</a></h3>
Expand All @@ -402,11 +402,11 @@ <h3><a name="7">Demonstration 7</a></h3>
Number of resamples (outer): 1999
Number of resamples (inner): 199
Confidence interval (CI) type: Calibrated percentile
Nominal coverage (and the percentiles used): 90% (12.0%, 99.5%)
Nominal coverage (and the percentiles used): 90% (10.5%, 99.5%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -7.692 +45.06 +113.8 +275.9</pre>
+171.5 -7.392 +44.50 +112.0 +282.0</pre>
</div>

<h3><a name="8">Demonstration 8</a></h3>
Expand All @@ -433,8 +433,8 @@ <h3><a name="8">Demonstration 8</a></h3>

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
-0.2385 +0.0008506 +0.2941 -0.6348 +0.3469
-0.1505 -0.005069 +0.3300 -0.6846 +0.4004</pre>
+0.03762 +0.008705 +0.1750 -0.2850 +0.2904
+0.1001 -0.03228 +0.2525 -0.3477 +0.4544</pre>
</div>

<h3><a name="9">Demonstration 9</a></h3>
Expand All @@ -461,11 +461,11 @@ <h3><a name="9">Demonstration 9</a></h3>
Number of resamples (outer): 1999
Number of resamples (inner): 0
Confidence interval (CI) type: Bias-corrected and accelerated (BCa)
Nominal coverage (and the percentiles used): 95% (0.5%, 93.6%)
Nominal coverage (and the percentiles used): 95% (0.4%, 92.8%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+0.7764 -0.005495 +0.1353 +0.3591 +0.9463</pre>
+0.7764 -0.005893 +0.1403 +0.2548 +0.9438</pre>
</div>

<h3><a name="10">Demonstration 10</a></h3>
Expand Down Expand Up @@ -577,13 +577,13 @@ <h3><a name="10">Demonstration 10</a></h3>

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
-16.69 -0.5096 +2.046 -20.36 -12.56
-11.72 -0.3575 +1.785 -14.99 -8.157
-8.061 -0.2587 +1.680 -11.15 -4.605
+0.1048 +0.005536 +0.08937 -0.07576 +0.2695
+0.01034 +0.0007082 +0.006622 -0.003099 +0.02326
+0.06452 +0.002339 +0.01603 +0.03253 +0.09484
+0.001664 +3.010e-06 +0.0007336 +0.0002312 +0.003136</pre>
-16.69 -0.5257 +2.102 -20.20 -12.24
-11.72 -0.3640 +1.843 -14.95 -7.903
-8.061 -0.2629 +1.749 -11.15 -4.376
+0.1048 +0.005331 +0.09083 -0.07590 +0.2793
+0.01034 +0.0007389 +0.006778 -0.002881 +0.02330
+0.06452 +0.002321 +0.01701 +0.03197 +0.09676
+0.001664 +6.490e-06 +0.0007586 +0.0002368 +0.003140</pre>
</div>

<h3><a name="11">Demonstration 11</a></h3>
Expand Down
Loading

0 comments on commit 75f514c

Please sign in to comment.