Skip to content

Commit

Permalink
update readme in manual
Browse files Browse the repository at this point in the history
  • Loading branch information
acp29 committed Feb 26, 2024
1 parent a115f97 commit ac84d88
Show file tree
Hide file tree
Showing 27 changed files with 237 additions and 209 deletions.
22 changes: 18 additions & 4 deletions README.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
<h2 id="read-me">Read me</h2>
<p><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
href="https://gnu-octave.github.io/statistics-resampling/"><img
src="https://img.shields.io/badge/docs-online-blue.svg"
alt="Documentation" /></a> <a
href="https://doi.org/10.5281/zenodo.3992392"><img
src="https://zenodo.org/badge/DOI/10.5281/zenodo.3992392.svg"
alt="DOI" /></a></p>
<h3 id="package-maintainer">Package maintainer</h3>
<p>Andrew Penn ([email protected])</p>
<h3 id="package-contributors">Package contributors</h3>
Expand All @@ -10,7 +19,10 @@ <h3 id="citations">Citations</h3>
<ul>
<li>Penn, Andrew Charles. (2020). Resampling methods for small samples
or samples with complex dependence structures. <em>Zenodo</em>. <a
href="https://doi.org/10.5281/zenodo.3992392">https://doi.org/10.5281/zenodo.3992392</a></li>
href="https://doi.org/10.5281/zenodo.3992392">https://doi.org/10.5281/zenodo.3992392</a>
<a href="https://doi.org/10.5281/zenodo.3992392"><img
src="https://zenodo.org/badge/DOI/10.5281/zenodo.3992392.svg"
alt="DOI" /></a></li>
</ul>
<p>(Note that package versions 5.4.3 and below were named the
‘statistics-bootstrap’ package. The ‘statistics-resampling’ package is a
Expand Down Expand Up @@ -159,9 +171,11 @@ <h3 id="usage">Usage</h3>
environment <a
href="https://github.com/acpennlab/statistics-resampling-online/"><img
src="https://img.shields.io/github/forks/acpennlab/statistics-resampling-online?label=GitHub%20Repo&amp;style=social" /></a>.
Using Jupyter notebooks, you can also integrate use of the
statistics-resampling package into your analysis workflow alongside
other programming languages (e.g. Python, R etc.) <a
Alternatively, you could fork the repository or use it as a template for
you own GitHub repository. Using Jupyter notebooks, you can also
integrate use of the statistics-resampling package into your analysis
workflow alongside other programming languages including Python, R and
Julia <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></em></p>
<h3 id="quick-start">Quick start</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-23"/>
<meta name="date" content="2024-02-26"/>
<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-23",
"date_generated": "2024-02-26",
"package":
{
"name": "statistics-resampling",
Expand Down
26 changes: 13 additions & 13 deletions 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-23"/>
<meta name="date" content="2024-02-26"/>
<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 @@ -118,15 +118,15 @@ <h3><a name="1">Demonstration 1</a></h3>

Columns 1 through 10:

2 2 3 3 1 1 2 2 3 2
2 3 3 2 1 1 1 2 3 3
3 2 3 3 2 2 2 1 3 3
3 3 1 2 1 3 2 3 2 1
3 3 1 2 1 1 1 2 3 1
3 2 2 3 2 2 2 1 3 1

Columns 11 through 20:

2 3 3 1 3 2 1 2 3 1
3 1 1 2 3 3 2 1 1 2
1 1 1 1 2 1 2 1 3 1</pre>
1 3 2 1 3 3 2 2 2 3
1 2 1 2 3 3 1 1 3 1
2 3 2 3 2 1 1 1 3 2</pre>
</div>

<h3><a name="2">Demonstration 2</a></h3>
Expand All @@ -141,15 +141,15 @@ <h3><a name="2">Demonstration 2</a></h3>

Columns 1 through 10:

3 3 2 3 1 2 2 1 1 3
2 1 1 2 1 1 3 1 1 3
2 3 1 3 3 2 3 1 1 3
3 3 1 3 3 2 2 1 1 2
2 1 2 3 3 2 3 3 1 3
3 3 1 2 1 2 2 1 1 2

Columns 11 through 20:

3 1 2 3 2 2 1 2 2 3
3 2 3 1 1 3 1 2 2 2
3 1 3 3 1 2 1 2 2 2</pre>
1 1 3 3 1 3 1 2 2 1
1 1 3 3 2 3 1 2 2 1
3 2 2 1 2 2 3 2 3 1</pre>
</div>

<h3><a name="3">Demonstration 3</a></h3>
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-23"/>
<meta name="date" content="2024-02-26"/>
<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.1008 | -0.22 | .789 |
| 1 | 2 | 1 | -0.6556 | -1.63 | .099 |

-----------------------------------------------------------------------------
| 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.2146 | +0.11 | .763 |
| 1 | 2 | 1 | -0.5803 | -0.76 | .279 |

-----------------------------------------------------------------------------
| 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-23"/>
<meta name="date" content="2024-02-26"/>
<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.01529 +184.5 1.351 +181.7 +187.2</pre>
+184.5 -0.01240 +184.4 1.323 +181.9 +187.2</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.07775 +175.4 2.287 +171.1 +179.9
+0.1904 +0.002169 +0.1929 0.07622 +0.03454 +0.3340</pre>
+175.5 -0.0005089 +175.5 2.379 +171.2 +180.5
+0.1904 -0.0005357 +0.1916 0.07946 +0.04301 +0.3549</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-23"/>
<meta name="date" content="2024-02-26"/>
<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
48 changes: 24 additions & 24 deletions 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-23"/>
<meta name="date" content="2024-02-26"/>
<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 @@ -184,8 +184,8 @@ <h3><a name="1">Demonstration 1</a></h3>
<p>Produces the following output</p>
<pre class="example">ci =

23.616
34.358</pre>
23.825
34.411</pre>
</div>

<h3><a name="2">Demonstration 2</a></h3>
Expand All @@ -204,8 +204,8 @@ <h3><a name="2">Demonstration 2</a></h3>
<p>Produces the following output</p>
<pre class="example">ci =

23.975
34.269</pre>
23.462
34.651</pre>
</div>

<h3><a name="3">Demonstration 3</a></h3>
Expand All @@ -225,8 +225,8 @@ <h3><a name="3">Demonstration 3</a></h3>
<p>Produces the following output</p>
<pre class="example">ci =

25.04
36.477</pre>
24.811
36.698</pre>
</div>

<h3><a name="4">Demonstration 4</a></h3>
Expand All @@ -243,8 +243,8 @@ <h3><a name="4">Demonstration 4</a></h3>
<p>Produces the following output</p>
<pre class="example">ci =

96.629
235.91</pre>
100.29
233.9</pre>
</div>

<h3><a name="5">Demonstration 5</a></h3>
Expand All @@ -261,8 +261,8 @@ <h3><a name="5">Demonstration 5</a></h3>
<p>Produces the following output</p>
<pre class="example">ci =

117.01
260.73</pre>
116.4
265.89</pre>
</div>

<h3><a name="6">Demonstration 6</a></h3>
Expand All @@ -282,8 +282,8 @@ <h3><a name="6">Demonstration 6</a></h3>
<p>Produces the following output</p>
<pre class="example">ci =

108.55
297.71</pre>
106.75
290.95</pre>
</div>

<h3><a name="7">Demonstration 7</a></h3>
Expand All @@ -303,8 +303,8 @@ <h3><a name="7">Demonstration 7</a></h3>
<p>Produces the following output</p>
<pre class="example">ci =

111.53
268.13</pre>
115.81
278.35</pre>
</div>

<h3><a name="8">Demonstration 8</a></h3>
Expand All @@ -325,8 +325,8 @@ <h3><a name="8">Demonstration 8</a></h3>
<p>Produces the following output</p>
<pre class="example">ci =

0.50501
0.86333</pre>
0.51674
0.873</pre>
</div>

<h3><a name="9">Demonstration 9</a></h3>
Expand Down Expand Up @@ -431,13 +431,13 @@ <h3><a name="9">Demonstration 9</a></h3>
<p>Produces the following output</p>
<pre class="example">ans =

-16.69 -20.555 -12.325
-11.721 -15.104 -7.907
-8.0606 -11.244 -4.3564
0.10476 -0.081023 0.28225
0.010336 -0.0032993 0.022647
0.06452 0.033083 0.095608
0.0016638 0.00017173 0.0031554</pre>
-16.69 -20.526 -12.642
-11.721 -15.188 -8.0851
-8.0606 -11.299 -4.6596
0.10476 -0.062295 0.28823
0.010336 -0.00273 0.023016
0.06452 0.033493 0.094721
0.0016638 0.00019837 0.0031828</pre>
</div>

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

0 comments on commit ac84d88

Please sign in to comment.