update manual

acpennlab · Jan 6, 2024 · 71c28cb · 71c28cb
1 parent 7d80543
commit 71c28cb
Show file tree

Hide file tree

Showing 25 changed files with 246 additions and 192 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-04"/>
+  <meta name="date" content="2024-01-06"/>
   <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,7 +1,7 @@
 {
   "generator": "generate_html",
   "generator_version": "0.3.3",
-  "date_generated": "2024-01-04",
+  "date_generated": "2024-01-06",
   "package": 
   {
     "name": "statistics-resampling",

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-04"/>
+  <meta name="date" content="2024-01-06"/>
   <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." />
@@ -43,6 +43,9 @@
      are chosen by balanced bootstrap resampling as described above [1-3].
      Balanced resampling only applies when NBOOT > 1.
 
+     Note that the values of N and NBOOT map onto int32 data types in the 
+     boot MEX file. Therefore, these values must never exceed (2^31)-1.
+
      'BOOTSAM = boot (..., NBOOT, LOO)' sets the resampling method. If LOO
      is false, the resampling method used is balanced bootstrap resampling.
      If LOO is true, the resampling method used is balanced bootknife
@@ -72,6 +75,7 @@
      corresponding index (or element in X) is represented in BOOTSAM.
      Therefore, the sum of WEIGHTS must equal N * NBOOT. 
 
+
   Bibliography:
   [1] Efron, and Tibshirani (1993) An Introduction to the
         Bootstrap. New York, NY: Chapman & Hall
@@ -111,9 +115,9 @@ <h2>Demonstration 1</h2>
 <p>Produces the following output</p>
 <pre class="example">ans =
 
-   3   3   1   2   1   3   2   3   2   1   1   3   2   1   3   3   2   2   2   3
-   3   3   1   2   1   1   1   2   3   1   1   2   1   2   3   3   1   1   3   1
-   3   2   2   3   2   2   2   1   3   1   2   3   2   3   2   1   1   1   3   2</pre>
+   3   1   1   2   3   3   2   1   2   2   3   1   3   1   3   1   1   3   3   3
+   2   2   3   3   1   1   3   1   2   1   1   2   2   2   2   2   3   3   2   3
+   1   2   1   3   1   1   1   1   2   2   3   1   3   2   2   2   3   1   2   3</pre>
 </div>
 <h2>Demonstration 2</h2>
 <div class="demo">
@@ -125,9 +129,9 @@ <h2>Demonstration 2</h2>
 <p>Produces the following output</p>
 <pre class="example">ans =
 
-   3   3   1   3   3   2   2   1   1   2   1   1   3   3   1   3   1   2   2   1
-   2   1   2   3   3   2   3   3   1   3   1   1   3   3   2   3   1   2   2   1
-   3   3   1   2   1   2   2   1   1   2   3   2   2   1   2   2   3   2   3   1</pre>
+   3   3   1   2   3   1   2   1   2   2   1   1   3   1   2   2   3   1   1   1
+   3   3   2   3   3   2   2   1   2   2   1   2   3   1   2   3   3   2   3   1
+   3   1   1   2   3   2   3   1   1   3   3   2   3   1   2   3   1   2   1   2</pre>
 </div>
 <h2>Demonstration 3</h2>
 <div class="demo">

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-04"/>
+  <meta name="date" content="2024-01-06"/>
   <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." />
@@ -472,7 +472,7 @@ <h2>Demonstration 6</h2>
 -----------------------------------------------------------------------------
 | Comparison |     Test # |      Ref # | Difference |          t |        p |
 |------------|------------|------------|------------|------------|----------|
-|          1 |          2 |          1 |    +0.1328 |      +0.29 |     .776 |
+|          1 |          2 |          1 |  +0.004848 |      +0.01 |     .996 |
 
 -----------------------------------------------------------------------------
 |    GROUP # |                                       GROUP label |        N |
@@ -517,7 +517,7 @@ <h2>Demonstration 7</h2>
 -----------------------------------------------------------------------------
 | Comparison |     Test # |      Ref # | Difference |          t |        p |
 |------------|------------|------------|------------|------------|----------|
-|          1 |          2 |          1 |    -0.3151 |      -0.56 |     .431 |
+|          1 |          2 |          1 |    -0.2044 |      -0.39 |     .603 |
 
 -----------------------------------------------------------------------------
 |    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-04"/>
+  <meta name="date" content="2024-01-06"/>
   <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." />
@@ -185,7 +185,7 @@ <h2>Demonstration 1</h2>
 
 Posterior Statistics: 
  original     bias         median       stdev       CI_lower      CI_upper
- +184.5       +0.01592     +184.4       1.325       +182.0        +187.2</pre>
+ +184.5       -0.01585     +184.5       1.311       +182.0        +187.1</pre>
 </div>
 <h2>Demonstration 2</h2>
 <div class="demo">
@@ -221,8 +221,8 @@ <h2>Demonstration 2</h2>
 
 Posterior Statistics: 
  original     bias         median       stdev       CI_lower      CI_upper
- +175.5       -0.01061     +175.5       2.414       +171.1        +180.5    
- +0.1904      -0.0007931   +0.1917      0.08040     +0.04178      +0.3556</pre>
+ +175.5       -0.09230     +175.4       2.415       +171.1        +180.4    
+ +0.1904      +0.002915    +0.1921      0.07944     +0.04305      +0.3495</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-04"/>
+  <meta name="date" content="2024-01-06"/>
   <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-04"/>
+  <meta name="date" content="2024-01-06"/>
   <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." />
@@ -182,8 +182,8 @@ <h2>Demonstration 1</h2>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-   23.540
-   34.574</pre>
+   23.616
+   34.358</pre>
 </div>
 <h2>Demonstration 2</h2>
 <div class="demo">
@@ -201,8 +201,8 @@ <h2>Demonstration 2</h2>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-   23.886
-   34.390</pre>
+   23.975
+   34.269</pre>
 </div>
 <h2>Demonstration 3</h2>
 <div class="demo">
@@ -221,8 +221,8 @@ <h2>Demonstration 3</h2>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-   24.710
-   37.094</pre>
+   25.040
+   36.477</pre>
 </div>
 <h2>Demonstration 4</h2>
 <div class="demo">
@@ -238,8 +238,8 @@ <h2>Demonstration 4</h2>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-    96.788
-   237.389</pre>
+    96.629
+   235.910</pre>
 </div>
 <h2>Demonstration 5</h2>
 <div class="demo">
@@ -255,8 +255,8 @@ <h2>Demonstration 5</h2>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-   116.08
-   263.28</pre>
+   117.01
+   260.73</pre>
 </div>
 <h2>Demonstration 6</h2>
 <div class="demo">
@@ -275,8 +275,8 @@ <h2>Demonstration 6</h2>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-   116.56
-   293.82</pre>
+   108.55
+   297.71</pre>
 </div>
 <h2>Demonstration 7</h2>
 <div class="demo">
@@ -295,8 +295,8 @@ <h2>Demonstration 7</h2>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-   112.32
-   280.18</pre>
+   111.53
+   268.13</pre>
 </div>
 <h2>Demonstration 8</h2>
 <div class="demo">
@@ -316,8 +316,8 @@ <h2>Demonstration 8</h2>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-   0.5174
-   0.8637</pre>
+   0.5050
+   0.8633</pre>
 </div>
 <h2>Demonstration 9</h2>
 <div class="demo">

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-04"/>
+  <meta name="date" content="2024-01-06"/>
   <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." />
@@ -172,7 +172,7 @@ <h2>Demonstration 1</h2>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +29.65       -4.619e-14   +2.638       +23.27       +34.70</pre>
+ +29.65       +1.421e-14   +2.547       +23.48       +34.49</pre>
 </div>
 <h2>Demonstration 2</h2>
 <div class="demo">
@@ -197,11 +197,11 @@ <h2>Demonstration 2</h2>
  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.3%, 98.9%)
+ Nominal coverage (and the percentiles used): 95% (1.2%, 98.9%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +29.65       -0.03867     +2.896       +23.07       +36.16</pre>
+ +29.65       -0.03188     +2.912       +23.04       +35.99</pre>
 </div>
 <h2>Demonstration 3</h2>
 <div class="demo">
@@ -228,7 +228,7 @@ <h2>Demonstration 3</h2>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +171.5       -6.654       +42.63       +96.46       +234.8</pre>
+ +171.5       -6.354       +42.51       +97.80       +236.1</pre>
 </div>
 <h2>Demonstration 4</h2>
 <div class="demo">
@@ -257,7 +257,7 @@ <h2>Demonstration 4</h2>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +171.5       -9.393       +34.16       +102.6       +215.7</pre>
+ +171.5       -9.381       +33.37       +104.1       +214.3</pre>
 </div>
 <h2>Demonstration 5</h2>
 <div class="demo">
@@ -279,11 +279,11 @@ <h2>Demonstration 5</h2>
  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% (11.9%, 98.7%)
+ Nominal coverage (and the percentiles used): 90% (10.7%, 98.4%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +171.5       -6.689       +41.19       +115.9       +258.5</pre>
+ +171.5       -6.485       +41.58       +112.9       +252.7</pre>
 </div>
 <h2>Demonstration 6</h2>
 <div class="demo">
@@ -307,11 +307,11 @@ <h2>Demonstration 6</h2>
  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.2%, 98.7%)
+ Nominal coverage (and the percentiles used): 90% (12.5%, 98.6%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +171.5       -9.602       +34.15       +122.7       +231.3</pre>
+ +171.5       -9.414       +33.59       +121.9       +231.1</pre>
 </div>
 <h2>Demonstration 7</h2>
 <div class="demo">
@@ -336,8 +336,8 @@ <h2>Demonstration 7</h2>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- -0.05747     +0.009976    +0.2228      -0.4408      +0.2894    
- -0.2821      +0.009019    +0.2021      -0.5871      +0.07347</pre>
+ -0.2246      +0.003490    +0.2145      -0.6148      +0.09204   
+ -0.09154     +0.0006074   +0.2059      -0.4611      +0.2211</pre>
 </div>
 <h2>Demonstration 8</h2>
 <div class="demo">
@@ -363,8 +363,8 @@ <h2>Demonstration 8</h2>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- -0.1846      -0.007533    +0.08858     -0.3732      -0.07310   
- -0.001791    +0.03147     +0.1574      -0.2306      +0.2747</pre>
+ +0.2463      +0.02234     +0.2264      -0.08453     +0.6083    
+ +0.1312      -0.02858     +0.2918      -0.3834      +0.4772</pre>
 </div>
 <h2>Demonstration 9</h2>
 <div class="demo">
@@ -390,11 +390,11 @@ <h2>Demonstration 9</h2>
  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.2%, 97.2%)
+ Nominal coverage (and the percentiles used): 95% (1.9%, 97.0%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +0.7764      -0.02400     +0.1423      +0.4177      +0.9997</pre>
+ +0.7764      -0.02475     +0.1457      +0.4011      +1.000</pre>
 </div>
 
 <p>Package: <a href="../index.html">statistics-resampling</a></p>