Update manual

acpennlab · Jan 24, 2024 · 7474e3d · 7474e3d
1 parent 1c340da
commit 7474e3d
Show file tree

Hide file tree

Showing 25 changed files with 315 additions and 256 deletions.
diff --git a/docs/copying.html b/docs/copying.html
@@ -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-22"/>
+  <meta name="date" content="2024-01-24"/>
   <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." />

diff --git a/docs/description.json b/docs/description.json
@@ -1,14 +1,14 @@
 {
   "generator": "generate_html",
   "generator_version": "0.3.3",
-  "date_generated": "2024-01-22",
+  "date_generated": "2024-01-24",
   "package": 
   {
     "name": "statistics-resampling",
     "version": "5.5.6",
     "description": "The statistics-resampling package is an Octave  package and Matlab toolbox that can be used to overcome a wide  variety of statistics problems using non-parametric resampling  methods. In particular, the functions included can be used to  estimate bias, uncertainty (standard errors and confidence  intervals), prediction error, and test hypotheses (p-values).  Variations of the resampling methods are included that improve  the accuracy of the statistics for small samples and samples  with complex dependence structures.",
     "shortdescription": "The statistics-resampling package is an Octave  package and Matlab toolbox that can be used to overcome a wide  variety of statistics problems using non-parametric resampling  methods",
-    "date": "2024-01-20",
+    "date": "2024-01-23",
     "title": "A statistics package with a variety of resampling tools",
     "author": "Andrew Penn <[email protected]>",
     "maintainer": "Andrew Penn <[email protected]>",

diff --git a/docs/function/boot.html b/docs/function/boot.html
@@ -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-22"/>
+  <meta name="date" content="2024-01-24"/>
   <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." />
@@ -118,15 +118,15 @@ <h3><a name="1">Demonstration 1</a></h3>
 
  Columns 1 through 13:
 
-            3            3            1            2            1            3            2            3            2            1            1            3            2
-            3            3            1            2            1            1            1            2            3            1            1            2            1
-            3            2            2            3            2            2            2            1            3            1            2            3            2
+            2            2            3            3            1            1            2            2            3            2            2            3            3
+            2            3            3            2            1            1            1            2            3            3            3            1            1
+            3            2            3            3            2            2            2            1            3            3            1            1            1
 
  Columns 14 through 20:
 
-            1            3            3            2            2            2            3
-            2            3            3            1            1            3            1
-            3            2            1            1            1            3            2</pre>
+            1            3            2            1            2            3            1
+            2            3            3            2            1            1            2
+            1            2            1            2            1            3            1</pre>
 </div>
 
 <h3><a name="2">Demonstration 2</a></h3>
@@ -141,15 +141,15 @@ <h3><a name="2">Demonstration 2</a></h3>
 
  Columns 1 through 13:
 
-            3            3            1            3            3            2            2            1            1            2            1            1            3
-            2            1            2            3            3            2            3            3            1            3            1            1            3
-            3            3            1            2            1            2            2            1            1            2            3            2            2
+            3            3            2            3            1            2            2            1            1            3            3            1            2
+            2            1            1            2            1            1            3            1            1            3            3            2            3
+            2            3            1            3            3            2            3            1            1            3            3            1            3
 
  Columns 14 through 20:
 
-            3            1            3            1            2            2            1
-            3            2            3            1            2            2            1
-            1            2            2            3            2            3            1</pre>
+            3            2            2            1            2            2            3
+            1            1            3            1            2            2            2
+            3            1            2            1            2            2            2</pre>
 </div>
 
 <h3><a name="3">Demonstration 3</a></h3>

diff --git a/docs/function/boot1way.html b/docs/function/boot1way.html
@@ -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-22"/>
+  <meta name="date" content="2024-01-24"/>
   <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." />
@@ -528,7 +528,7 @@ <h3><a name="7">Demonstration 7</a></h3>
 -----------------------------------------------------------------------------
 | Comparison |     Test # |      Ref # | Difference |          t |        p |
 |------------|------------|------------|------------|------------|----------|
-|          1 |          2 |          1 |    -0.2316 |      -0.47 |     .625 |
+|          1 |          2 |          1 |    -0.3898 |      -0.88 |     .358 |
 
 -----------------------------------------------------------------------------
 |    GROUP # |                                       GROUP label |        N |
@@ -573,7 +573,7 @@ <h3><a name="8">Demonstration 8</a></h3>
 -----------------------------------------------------------------------------
 | Comparison |     Test # |      Ref # | Difference |          t |        p |
 |------------|------------|------------|------------|------------|----------|
-|          1 |          2 |          1 |    -0.2051 |      -0.43 |     .414 |
+|          1 |          2 |          1 |    +0.8076 |      +1.63 |     .067 |
 
 -----------------------------------------------------------------------------
 |    GROUP # |                                       GROUP label |        N |

diff --git a/docs/function/bootbayes.html b/docs/function/bootbayes.html
@@ -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-22"/>
+  <meta name="date" content="2024-01-24"/>
   <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." />
@@ -118,6 +118,10 @@ <h2>bootbayes</h2>
 
          std (BOOTSTAT, 1, 2) ~ std (Y, 1) == std (Y, 0) / sqrt (N) 
 
+     Note that in this particular case, intervals will be computed using
+     the standard deviation of the posterior distribution and quantiles
+     from a standard normal distribution.
+
      'bootbayes (Y, X, ..., NBOOT, PROB, PRIOR, SEED)' initialises the
      Mersenne Twister random number generator using an integer SEED value so
      that 'bootbayes' results are reproducible.
@@ -187,7 +191,7 @@ <h3><a name="1">Demonstration 1</a></h3>
 
 Posterior Statistics: 
  original     bias         median       stdev       CI_lower      CI_upper
- +184.5       +0.01851     +184.5       1.320       +181.9        +187.1</pre>
+ +184.5       +0.01529     +184.5       1.351       +181.7        +187.2</pre>
 </div>
 
 <h3><a name="2">Demonstration 2</a></h3>
@@ -224,8 +228,8 @@ <h3><a name="2">Demonstration 2</a></h3>
 
 Posterior Statistics: 
  original     bias         median       stdev       CI_lower      CI_upper
- +175.5       -0.001409    +175.5       2.388       +171.1        +180.4    
- +0.1904      -0.0002445   +0.1913      0.07837     +0.04364      +0.3444</pre>
+ +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>
 </div>
 
 <p>Package: <a href="../index.html">statistics-resampling</a></p>

diff --git a/docs/function/bootcdf.html b/docs/function/bootcdf.html
@@ -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-22"/>
+  <meta name="date" content="2024-01-24"/>
   <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." />

diff --git a/docs/function/bootci.html b/docs/function/bootci.html
@@ -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-22"/>
+  <meta name="date" content="2024-01-24"/>
   <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." />
@@ -184,8 +184,8 @@ <h3><a name="1">Demonstration 1</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-       23.825
-       34.411</pre>
+       23.616
+       34.358</pre>
 </div>
 
 <h3><a name="2">Demonstration 2</a></h3>
@@ -204,8 +204,8 @@ <h3><a name="2">Demonstration 2</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-       23.462
-       34.651</pre>
+       23.975
+       34.269</pre>
 </div>
 
 <h3><a name="3">Demonstration 3</a></h3>
@@ -225,8 +225,8 @@ <h3><a name="3">Demonstration 3</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-       24.811
-       36.698</pre>
+        25.04
+       36.477</pre>
 </div>
 
 <h3><a name="4">Demonstration 4</a></h3>
@@ -243,8 +243,8 @@ <h3><a name="4">Demonstration 4</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-       100.29
-        233.9</pre>
+       96.629
+       235.91</pre>
 </div>
 
 <h3><a name="5">Demonstration 5</a></h3>
@@ -261,8 +261,8 @@ <h3><a name="5">Demonstration 5</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-        116.4
-       265.89</pre>
+       117.01
+       260.73</pre>
 </div>
 
 <h3><a name="6">Demonstration 6</a></h3>
@@ -282,8 +282,8 @@ <h3><a name="6">Demonstration 6</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-       106.75
-       290.95</pre>
+       108.55
+       297.71</pre>
 </div>
 
 <h3><a name="7">Demonstration 7</a></h3>
@@ -303,8 +303,8 @@ <h3><a name="7">Demonstration 7</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-       115.81
-       278.35</pre>
+       111.53
+       268.13</pre>
 </div>
 
 <h3><a name="8">Demonstration 8</a></h3>
@@ -325,8 +325,8 @@ <h3><a name="8">Demonstration 8</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-      0.51674
-        0.873</pre>
+      0.50501
+      0.86333</pre>
 </div>
 
 <h3><a name="9">Demonstration 9</a></h3>
@@ -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.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>
+       -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>

diff --git a/docs/function/bootclust.html b/docs/function/bootclust.html
@@ -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-22"/>
+  <meta name="date" content="2024-01-24"/>
   <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." />
@@ -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.2%)
+ Nominal coverage (and the percentiles used): 95% (1.3%, 97.6%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +29.65       +4.619e-14   +2.575       +23.27       +34.37</pre>
+ +29.65       +1.066e-14   +2.579       +23.85       +34.68</pre>
 </div>
 
 <h3><a name="2">Demonstration 2</a></h3>
@@ -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.2%, 98.8%)
+ Nominal coverage (and the percentiles used): 95% (1.4%, 99.0%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +29.65       -0.04243     +2.933       +22.99       +36.16</pre>
+ +29.65       -0.03173     +2.871       +23.28       +36.33</pre>
 </div>
 
 <h3><a name="3">Demonstration 3</a></h3>
@@ -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.556       +42.91       +95.35       +237.7</pre>
+ +171.5       -6.648       +41.77       +98.16       +235.6</pre>
 </div>
 
 <h3><a name="4">Demonstration 4</a></h3>
@@ -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.538       +34.01       +103.7       +215.8</pre>
+ +171.5       -9.616       +33.17       +104.8       +214.0</pre>
 </div>
 
 <h3><a name="5">Demonstration 5</a></h3>
@@ -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.2%, 98.7%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +171.5       -6.556       +40.48       +118.4       +257.2</pre>
+ +171.5       -6.544       +42.20       +115.9       +263.7</pre>
 </div>
 
 <h3><a name="6">Demonstration 6</a></h3>
@@ -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% (13.8%, 98.8%)
+ Nominal coverage (and the percentiles used): 90% (13.5%, 98.8%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +171.5       -9.948       +34.41       +123.1       +234.2</pre>
+ +171.5       -9.804       +33.43       +123.8       +231.4</pre>
 </div>
 
 <h3><a name="7">Demonstration 7</a></h3>
@@ -344,8 +344,8 @@ <h3><a name="7">Demonstration 7</a></h3>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- -0.2856      +0.02612     +0.2237      -0.6558      +0.06714   
- -0.02295     -0.02754     +0.1580      -0.2881      +0.1964</pre>
+ -0.2666      +0.02243     +0.2679      -0.6970      +0.1652    
+ -0.1811      -0.02153     +0.2923      -0.6874      +0.2454</pre>
 </div>
 
 <h3><a name="8">Demonstration 8</a></h3>
@@ -372,8 +372,8 @@ <h3><a name="8">Demonstration 8</a></h3>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +0.2469      -0.0002864   +0.1286      +0.03449     +0.4569    
- +0.06161     +0.02892     +0.1087      -0.08660     +0.2212</pre>
+ +0.004980    +0.02224     +0.2339      -0.3471      +0.4229    
+ +0.04880     +0.01775     +0.1999      -0.2698      +0.3704</pre>
 </div>
 
 <h3><a name="9">Demonstration 9</a></h3>
@@ -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.5%)
+ Nominal coverage (and the percentiles used): 95% (2.1%, 97.2%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +0.7764      -0.02270     +0.1397      +0.4056      +0.9866</pre>
+ +0.7764      -0.02494     +0.1451      +0.4094      +1.003</pre>
 </div>
 
 <p>Package: <a href="../index.html">statistics-resampling</a></p>