Skip to content

Commit

Permalink
update manual
Browse files Browse the repository at this point in the history
  • Loading branch information
@acp29
acp29 committed Feb 21, 2024
1 parent 75f514c commit a0d267f
Show file tree
Hide file tree
Showing 27 changed files with 155 additions and 149 deletions.
5 changes: 4 additions & 1 deletion README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,10 @@ <h3 id="requirements-and-dependencies">Requirements and
href="https://gnu-octave.github.io/packages/parallel/">parallel
package</a> (in Octave) or the <a
href="https://uk.mathworks.com/products/parallel-computing.html">Parallel
Computing Matlab Toolbox</a> (in Matlab).<br />
Computing Matlab Toolbox</a> (in Matlab). Note that the Parallel package
in Octave also requires the <a
href="https://gnu-octave.github.io/packages/struct/">struct
package</a>.<br />
</li>
<li>The optional jackknife functionality in <code>boot1way</code>
requires the <a
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Follow the links in the 'Quick start' section below to obtain some examples of d

Users with greater computational demands may want to consider installing and running the statistics-resampling package offline. Installation of the statistics-resampling package has some software requirements. The core functions in this package require, and are known to be compatible with, [GNU Octave](https://octave.org/) (version >= 4.4.0) and [Matlab](https://uk.mathworks.com/products/matlab.html) (version >= R2007a 7.4.0). Some optional features of this package have further dependencies:

* All parallel computing options require either the [parallel package](https://gnu-octave.github.io/packages/parallel/) (in Octave) or the [Parallel Computing Matlab Toolbox](https://uk.mathworks.com/products/parallel-computing.html) (in Matlab).
* All parallel computing options require either the [parallel package](https://gnu-octave.github.io/packages/parallel/) (in Octave) or the [Parallel Computing Matlab Toolbox](https://uk.mathworks.com/products/parallel-computing.html) (in Matlab). Note that the Parallel package in Octave also requires the [struct package](https://gnu-octave.github.io/packages/struct/).
* The optional jackknife functionality in `boot1way` requires the [statistics package](https://gnu-octave.github.io/packages/statistics/) (in Octave) or the [Statistics and Machine Learning Toolbox](https://uk.mathworks.com/products/statistics.html) (in Matlab).

### Installation
Expand Down
2 changes: 1 addition & 1 deletion docs/copying.html
View file
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-20"/>
<meta name="date" content="2024-02-21"/>
<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
View file
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-20",
"date_generated": "2024-02-21",
"package":
{
"name": "statistics-resampling",
Expand Down
26 changes: 13 additions & 13 deletions docs/function/boot.html
View file
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-20"/>
<meta name="date" content="2024-02-21"/>
<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
View file
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-20"/>
<meta name="date" content="2024-02-21"/>
<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.1148 | +0.19 | .844 |
| 1 | 2 | 1 | -0.3796 | -1.15 | .216 |

-----------------------------------------------------------------------------
| 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.5577 | -0.57 | .465 |
| 1 | 2 | 1 | -0.6195 | -1.20 | .157 |

-----------------------------------------------------------------------------
| GROUP # | GROUP label | N |
Expand Down
2 changes: 1 addition & 1 deletion docs/function/bootbayes.html
View file
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-20"/>
<meta name="date" content="2024-02-21"/>
<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/bootcdf.html
View file
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-20"/>
<meta name="date" content="2024-02-21"/>
<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
View file
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-20"/>
<meta name="date" content="2024-02-21"/>
<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
34 changes: 17 additions & 17 deletions docs/function/bootclust.html
View file
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-20"/>
<meta name="date" content="2024-02-21"/>
<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 @@ -170,11 +170,11 @@ <h3><a name="1">Demonstration 1</a></h3>
Resampling method: Balanced, bootstrap cluster resampling
Number of resamples: 1999
Confidence interval (CI) type: Expanded bias-corrected and accelerated (BCa)
Nominal coverage (and the percentiles used): 95% (1.2%, 97.5%)
Nominal coverage (and the percentiles used): 95% (1.3%, 97.7%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+29.65 -4.263e-14 +2.546 +23.58 +34.50</pre>
+29.65 +1.421e-14 +2.563 +23.83 +34.64</pre>
</div>

<h3><a name="2">Demonstration 2</a></h3>
Expand All @@ -200,11 +200,11 @@ <h3><a name="2">Demonstration 2</a></h3>
Resampling method: Balanced, bootstrap cluster resampling
Number of resamples: 1999
Confidence interval (CI) type: Expanded bias-corrected and accelerated (BCa)
Nominal coverage (and the percentiles used): 95% (0.9%, 98.5%)
Nominal coverage (and the percentiles used): 95% (1.1%, 98.7%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+29.65 -0.04092 +2.935 +22.61 +35.83</pre>
+29.65 -0.04493 +2.894 +22.77 +35.82</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.491 +40.86 +99.28 +234.9</pre>
+171.5 -6.508 +42.24 +96.10 +233.8</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.145 +32.96 +105.8 +215.0</pre>
+171.5 -9.346 +32.65 +106.8 +214.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.7%, 98.8%)
Nominal coverage (and the percentiles used): 90% (12.4%, 98.8%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -6.336 +40.80 +118.7 +262.9</pre>
+171.5 -6.559 +42.48 +115.5 +266.0</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% (12.9%, 98.7%)
Nominal coverage (and the percentiles used): 90% (12.4%, 98.6%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -9.570 +32.89 +123.5 +229.9</pre>
+171.5 -9.240 +33.21 +122.5 +228.7</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.3965 +0.02430 +0.2575 -0.04019 +0.7941
+0.005570 -0.04574 +0.2760 -0.4817 +0.3911</pre>
-0.1719 -0.001385 +0.2062 -0.5470 +0.1371
+0.3198 -0.04381 +0.2572 -0.1363 +0.6711</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.2356 -0.03324 +0.1505 -0.4467 +0.02341
-0.06405 +0.002349 +0.1618 -0.3414 +0.1897</pre>
-0.1577 +0.03160 +0.1879 -0.4086 +0.1395
-0.1419 -0.04100 +0.2750 -0.6061 +0.1660</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% (2.0%, 97.0%)
Nominal coverage (and the percentiles used): 95% (1.6%, 96.4%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+0.7764 -0.02542 +0.1443 +0.4041 +0.9975</pre>
+0.7764 -0.02670 +0.1531 +0.3547 +0.9989</pre>
</div>

<p>Package: <a href="../index.html">statistics-resampling</a></p>
Expand Down
Loading

0 comments on commit a0d267f

Please sign in to comment.