updated the manual to include recent minor changes to function docume…

…ntation
acpennlab · Feb 16, 2024 · 57f9103 · 57f9103
1 parent 9129099
commit 57f9103
Show file tree

Hide file tree

Showing 24 changed files with 79 additions and 186 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-02-10"/>
+  <meta name="date" content="2024-02-16"/>
   <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-02-10",
+  "date_generated": "2024-02-16",
   "package": 
   {
     "name": "statistics-resampling",
-    "version": "5.5.6",
+    "version": "5.5.7",
     "description": "The statistics-resampling package is an Octave  package and Matlab toolbox that can be used to perform a wide  variety of statistics tasks 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 calculate p-values for null  hypothesis significance tests. 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 perform a wide  variety of statistics tasks using non-parametric resampling  methods",
-    "date": "2024-01-23",
+    "date": "2024-02-15",
     "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-02-10"/>
+  <meta name="date" content="2024-02-16"/>
   <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/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-02-10"/>
+  <meta name="date" content="2024-02-16"/>
   <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." />
@@ -98,10 +98,11 @@ <h2>boot1way</h2>
                           has already been started. 
         o 'nproc':        nproc sets the number of parallel processes
 
-     'PVAL = boot1way (DATA, GROUP, ...)' returns the p-value(s) from the 
-     (multiple) comparison test(s). Note that the p-value returned will be
+     'PVAL = boot1way (DATA, GROUP, ...)' returns the p-value(s) for the 
+     (multiple) two-tailed test(s). Note that the p-value(s) returned are
+     already adjusted to control the family-wise, type I error rate and 
      truncated at the resolution limit determined by the number of bootstrap
-     replicates, specifically 1/NBOOT(1). 
+     replicates, specifically 1/NBOOT(1)  
 
      '[PVAL, C] = boot1way (DATA, GROUP, ...)' also returns a 9 column matrix
      that summarises multiple comparison test results. The columns of C are:
@@ -528,7 +529,7 @@ <h3><a name="7">Demonstration 7</a></h3>
 -----------------------------------------------------------------------------
 | Comparison |     Test # |      Ref # | Difference |          t |        p |
 |------------|------------|------------|------------|------------|----------|
-|          1 |          2 |          1 |    -0.5462 |      -1.14 |     .286 |
+|          1 |          2 |          1 |   -0.03715 |      -0.09 |     .890 |
 
 -----------------------------------------------------------------------------
 |    GROUP # |                                       GROUP label |        N |
@@ -573,7 +574,7 @@ <h3><a name="8">Demonstration 8</a></h3>
 -----------------------------------------------------------------------------
 | Comparison |     Test # |      Ref # | Difference |          t |        p |
 |------------|------------|------------|------------|------------|----------|
-|          1 |          2 |          1 |    -0.2579 |      -0.34 |     .595 |
+|          1 |          2 |          1 |    -0.4850 |      -0.82 |     .268 |
 
 -----------------------------------------------------------------------------
 |    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-02-10"/>
+  <meta name="date" content="2024-02-16"/>
   <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/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-02-10"/>
+  <meta name="date" content="2024-02-16"/>
   <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-02-10"/>
+  <meta name="date" content="2024-02-16"/>
   <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/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-02-10"/>
+  <meta name="date" content="2024-02-16"/>
   <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.2%, 97.4%)
+ Nominal coverage (and the percentiles used): 95% (1.2%, 97.5%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +29.65       +3.553e-15   +2.578       +23.45       +34.52</pre>
+ +29.65       +7.105e-15   +2.594       +23.78       +34.61</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.0%, 98.7%)
+ Nominal coverage (and the percentiles used): 95% (1.1%, 98.8%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +29.65       -0.03888     +2.965       +22.56       +35.97</pre>
+ +29.65       -0.04239     +2.806       +23.09       +35.54</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.503       +42.64       +96.23       +236.8</pre>
+ +171.5       -6.477       +42.25       +97.41       +237.3</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.863       +33.35       +103.8       +213.9</pre>
+ +171.5       -9.043       +33.06       +106.3       +214.9</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.1%, 98.7%)
+ Nominal coverage (and the percentiles used): 90% (11.8%, 98.6%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +171.5       -6.748       +41.39       +115.7       +260.7</pre>
+ +171.5       -6.846       +42.65       +113.4       +261.5</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.3%, 98.7%)
+ Nominal coverage (and the percentiles used): 90% (13.8%, 98.8%)
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +171.5       -9.228       +33.69       +124.0       +230.9</pre>
+ +171.5       -9.368       +34.44       +123.6       +235.0</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.1619      -0.0008760   +0.2501      -0.5536      +0.2779    
- -0.09480     -0.002857    +0.1808      -0.3972      +0.2016</pre>
+ -0.2285      -0.001846    +0.1541      -0.4659      +0.04210   
+ +0.08417     +0.003592    +0.1202      -0.1268      +0.2624</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.1807      -0.01460     +0.1466      -0.04343     +0.4295    
- -0.4998      +0.01527     +0.2427      -0.8388      -0.05809</pre>
+ -0.08686     -0.02092     +0.1517      -0.3127      +0.1712    
+ +0.02272     -0.01786     +0.1145      -0.1460      +0.2314</pre>
 </div>
 
 <h3><a name="9">Demonstration 9</a></h3>
@@ -404,7 +404,7 @@ <h3><a name="9">Demonstration 9</a></h3>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +0.7764      -0.02413     +0.1435      +0.3987      +0.9946</pre>
+ +0.7764      -0.02403     +0.1424      +0.4034      +0.9933</pre>
 </div>
 
 <p>Package: <a href="../index.html">statistics-resampling</a></p>