Skip to content

Commit

Permalink
tweaked documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@acp29
acp29 committed Jan 10, 2024
1 parent 70598a4 commit f48e3ee
Show file tree
Hide file tree
Showing 26 changed files with 283 additions and 246 deletions.
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-01-09"/>
<meta name="date" content="2024-01-10"/>
<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-01-09",
"date_generated": "2024-01-10",
"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-01-09"/>
<meta name="date" content="2024-01-10"/>
<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 12:

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

Columns 13 through 20:

1 2 1 3 1 2 1 3
3 1 1 1 2 2 2 3
2 3 3 2 2 1 2 1</pre>
3 1 3 2 1 2 3 1
1 2 3 3 2 1 1 2
1 1 2 1 2 1 3 1</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 12:

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

Columns 13 through 20:

2 3 1 3 1 2 1 1
2 1 1 2 3 1 2 2
3 3 1 3 1 1 1 3</pre>
2 3 2 2 1 2 2 3
3 1 1 3 1 2 2 2
3 3 1 2 1 2 2 2</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-01-09"/>
<meta name="date" content="2024-01-10"/>
<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 @@ -528,7 +528,7 @@ <h3><a name="7">Demonstration 7</a></h3>
-----------------------------------------------------------------------------
| Comparison | Test # | Ref # | Difference | t | p |
|------------|------------|------------|------------|------------|----------|
| 1 | 2 | 1 | +0.2090 | +0.46 | .604 |
| 1 | 2 | 1 | +0.8611 | +2.83 | .013 |*

-----------------------------------------------------------------------------
| GROUP # | GROUP label | N |
Expand Down Expand Up @@ -573,7 +573,7 @@ <h3><a name="8">Demonstration 8</a></h3>
-----------------------------------------------------------------------------
| Comparison | Test # | Ref # | Difference | t | p |
|------------|------------|------------|------------|------------|----------|
| 1 | 2 | 1 | -0.8528 | -1.61 | .059 |
| 1 | 2 | 1 | +0.4548 | +0.50 | .474 |

-----------------------------------------------------------------------------
| GROUP # | GROUP label | N |
Expand Down
8 changes: 4 additions & 4 deletions 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-01-09"/>
<meta name="date" content="2024-01-10"/>
<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 @@ -187,7 +187,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.01222 +184.5 1.326 +181.8 +187.1</pre>
</div>

<h3><a name="2">Demonstration 2</a></h3>
Expand Down Expand Up @@ -224,8 +224,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.05523 +175.6 2.404 +170.8 +180.0
+0.1904 -0.002010 +0.1906 0.07972 +0.02251 +0.3314</pre>
</div>

<p>Package: <a href="../index.html">statistics-resampling</a></p>
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-01-09"/>
<meta name="date" content="2024-01-10"/>
<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
58 changes: 29 additions & 29 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-01-09"/>
<meta name="date" content="2024-01-10"/>
<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.76
34.42</pre>
23.616
34.358</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.559
34.47</pre>
23.975
34.269</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 =

24.642
37.064</pre>
25.04
36.477</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 =

98.519
238.89</pre>
96.629
235.91</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 =

115.61
257.61</pre>
117.01
260.73</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.01
294.74</pre>
108.55
297.71</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 =

113.22
274.06</pre>
111.53
268.13</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.48974
0.86621</pre>
0.50501
0.86333</pre>
</div>

<h3><a name="9">Demonstration 9</a></h3>
Expand All @@ -352,11 +352,11 @@ <h3><a name="9">Demonstration 9</a></h3>
% so we will use it's logistic_regression function for fitting ordinal
% models instead.
function [B, DEV] = mnrfit (X, Y, varargin)
% Note that the if the outcome has more than two levels, the
% logistic_regression function is only suitable when the outcome
% is ordinal, so we would need to use append 'model', 'ordinal'
% as a name-value pair in MATLAB when executing it's mnrfit
% function (see below)
% Note that if the outcome has more than two levels, the
% logistic_regression function is only suitable when the
% outcome is ordinal, so we would need to use append 'model',
% 'ordinal' as a name-value pair in MATLAB when executing
% it's mnrfit function (see below)
[INTERCEPT, SLOPE, DEV] = logistic_regression (Y - 1, X, false);
B = cat (1, INTERCEPT, SLOPE);
end
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.708 -12.631
-11.721 -15.325 -8.1335
-8.0606 -11.48 -4.5918
0.10476 -0.075934 0.27759
0.010336 -0.0023397 0.023668
0.06452 0.031991 0.095183
0.0016638 0.00020785 0.0030769</pre>
-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>
</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-01-09"/>
<meta name="date" content="2024-01-10"/>
<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.0%, 97.1%)
Nominal coverage (and the percentiles used): 95% (1.2%, 97.5%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+29.65 -2.842e-14 +2.581 +22.98 +34.22</pre>
+29.65 +3.553e-14 +2.523 +23.72 +34.45</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% (1.1%, 98.7%)
Nominal coverage (and the percentiles used): 95% (1.0%, 98.6%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+29.65 -0.04208 +3.000 +22.53 +35.94</pre>
+29.65 -0.03948 +2.926 +23.00 +35.88</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.575 +41.57 +98.47 +236.1</pre>
+171.5 -6.433 +41.32 +98.56 +233.4</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.098 +32.85 +105.8 +213.8</pre>
+171.5 -9.101 +33.53 +103.6 +214.9</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.2%, 98.7%)
Nominal coverage (and the percentiles used): 90% (12.6%, 98.8%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -6.331 +41.66 +116.8 +265.2</pre>
+171.5 -7.207 +41.84 +116.2 +263.7</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.5%, 98.6%)
Nominal coverage (and the percentiles used): 90% (13.4%, 98.8%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+171.5 -9.156 +34.09 +122.4 +231.5</pre>
+171.5 -9.472 +33.84 +122.9 +231.4</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.4651 +0.001961 +0.3238 -1.027 +0.03004
-0.1629 +0.03066 +0.3168 -0.5549 +0.4920</pre>
+0.1158 -0.01867 +0.2305 -0.2479 +0.5164
-0.07501 +0.0002203 +0.2306 -0.4560 +0.3089</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.2174 +0.004484 +0.1182 -0.4452 -0.04734
+0.2447 +0.01264 +0.09183 +0.09193 +0.3817</pre>
-0.1061 -0.03943 +0.2424 -0.4823 +0.2753
+0.2456 +0.04223 +0.1685 -0.05556 +0.4826</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.9%, 96.9%)

Bootstrap Statistics:
original bias std_error CI_lower CI_upper
+0.7764 -0.02467 +0.1443 +0.4066 +0.9989</pre>
+0.7764 -0.02413 +0.1448 +0.4022 +0.9982</pre>
</div>

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

0 comments on commit f48e3ee

Please sign in to comment.