update online manual

acpennlab · May 16, 2024 · ce6383d · ce6383d
1 parent 961b4f9
commit ce6383d
Show file tree

Hide file tree

Showing 27 changed files with 64 additions and 63 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-05-13"/>
+  <meta name="date" content="2024-05-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-05-13",
+  "date_generated": "2024-05-16",
   "package": 
   {
     "name": "statistics-resampling",
-    "version": "5.5.11",
+    "version": "5.5.12",
     "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-05-13",
+    "date": "2024-05-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-05-13"/>
+  <meta name="date" content="2024-05-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-05-13"/>
+  <meta name="date" content="2024-05-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." />
@@ -529,7 +529,7 @@ <h3><a name="7">Demonstration 7</a></h3>
 -----------------------------------------------------------------------------
 | Comparison |     Test # |      Ref # | Difference |          t |        p |
 |------------|------------|------------|------------|------------|----------|
-|          1 |          2 |          1 |    -0.3684 |      -0.63 |     .564 |
+|          1 |          2 |          1 |    +0.8304 |      +1.63 |     .161 |
 
 -----------------------------------------------------------------------------
 |    GROUP # |                                       GROUP label |        N |
@@ -574,7 +574,7 @@ <h3><a name="8">Demonstration 8</a></h3>
 -----------------------------------------------------------------------------
 | Comparison |     Test # |      Ref # | Difference |          t |        p |
 |------------|------------|------------|------------|------------|----------|
-|          1 |          2 |          1 |    +0.3039 |      +0.44 |     .600 |
+|          1 |          2 |          1 |    +0.6446 |      +1.33 |     .078 |
 
 -----------------------------------------------------------------------------
 |    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-05-13"/>
+  <meta name="date" content="2024-05-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." />
@@ -191,7 +191,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.02210     +184.5       1.240       +182.1        +186.9</pre>
 </div>
 
 <h3><a name="2">Demonstration 2</a></h3>
@@ -228,8 +228,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.03532     +175.5       2.384       +171.1        +180.3    
+ +0.1904      -0.001074    +0.1909      0.07912     +0.04160      +0.3442</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-05-13"/>
+  <meta name="date" content="2024-05-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-05-13"/>
+  <meta name="date" content="2024-05-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." />
@@ -468,8 +468,8 @@ <h3><a name="10">Demonstration 10</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-     -0.13896     -0.72921
-       0.7127      0.31607</pre>
+     -0.74781     -0.35862
+        0.276      0.50962</pre>
 </div>
 
 <h3><a name="11">Demonstration 11</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-05-13"/>
+  <meta name="date" content="2024-05-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." />
@@ -43,10 +43,10 @@ <h2>bootclust</h2>
      cluster/block (i.e. no clustering or blocking). The means of the resamples
      are then computed and the following statistics are displayed:
         - original: the original estimate(s) calculated by BOOTFUN and the DATA
-        - bias: bootstrap bias of the estimate(s)
-        - std_error: bootstrap standard error of the estimate(s)
-        - CI_lower: lower bound(s) of the 95% bootstrap confidence interval
-        - CI_upper: upper bound(s) of the 95% bootstrap confidence interval
+        - bias: bootstrap estimate of the bias of the sampling distribution(s)
+        - std_error: bootstrap estimate(s) of the standard error(s)
+        - CI_lower: lower bound(s) of the 95% bootstrap confidence interval(s)
+        - CI_upper: upper bound(s) of the 95% bootstrap confidence interval(s)
 
      'bootclust (DATA, NBOOT)' specifies the number of bootstrap resamples,
      where NBOOT is a scalar, positive integer corresponding to the number
@@ -376,8 +376,8 @@ <h3><a name="7">Demonstration 7</a></h3>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +0.3052      -0.01557     +0.2059      -0.007480    +0.6725    
- -0.1663      +0.02261     +0.1710      -0.4057      +0.1247</pre>
+ +0.3625      -0.01706     +0.2193      +0.01007     +0.7266    
+ +0.2251      +0.001246    +0.2250      -0.1672      +0.5763</pre>
 </div>
 
 <h3><a name="8">Demonstration 8</a></h3>
@@ -406,8 +406,8 @@ <h3><a name="8">Demonstration 8</a></h3>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +0.1401      +0.006113    +0.2929      -0.4786      +0.5297    
- +0.04985     +0.009865    +0.1333      -0.1655      +0.2615</pre>
+ +0.1434      +0.02090     +0.1595      -0.03552     +0.4799    
+ -0.1623      +0.01750     +0.1080      -0.3331      +0.005695</pre>
 </div>
 
 <h3><a name="9">Demonstration 9</a></h3>

diff --git a/docs/function/bootint.html b/docs/function/bootint.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-05-13"/>
+  <meta name="date" content="2024-05-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/bootknife.html b/docs/function/bootknife.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-05-13"/>
+  <meta name="date" content="2024-05-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." />
@@ -42,10 +42,10 @@ <h2>bootknife</h2>
      (column vector or matrix) and compute their means and display the
      following statistics:
         - original: the original estimate(s) calculated by BOOTFUN and the DATA
-        - bias: bootstrap bias of the estimate(s)
-        - std_error: bootstrap standard error of the estimate(s)
-        - CI_lower: lower bound(s) of the 95% bootstrap confidence interval
-        - CI_upper: upper bound(s) of the 95% bootstrap confidence interval
+        - bias: bootstrap estimate of the bias of the sampling distribution(s)
+        - std_error: bootstrap estimate(s) of the standard error(s)
+        - CI_lower: lower bound(s) of the 95% bootstrap confidence interval(s)
+        - CI_upper: upper bound(s) of the 95% bootstrap confidence interval(s)
 
      'bootknife (DATA, NBOOT)' specifies the number of bootstrap resamples,
      where NBOOT can be either:
@@ -442,8 +442,8 @@ <h3><a name="8">Demonstration 8</a></h3>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +0.1034      -0.001186    +0.1974      -0.1832      +0.4674    
- -0.04645     +0.004099    +0.2699      -0.3929      +0.5239</pre>
+ +0.1331      -0.01506     +0.2166      -0.2376      +0.4716    
+ -0.5121      +0.01136     +0.1966      -0.9021      -0.2342</pre>
 </div>
 
 <h3><a name="9">Demonstration 9</a></h3>

diff --git a/docs/function/bootlm.html b/docs/function/bootlm.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-05-13"/>
+  <meta name="date" content="2024-05-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/bootmode.html b/docs/function/bootmode.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-05-13"/>
+  <meta name="date" content="2024-05-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." />
@@ -149,9 +149,9 @@ <h3><a name="1">Demonstration 1</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ans = Summary of results:
 
-ans = H1 is 1 with p = 0.001 so reject the null hypothesisthat there is 1 mode
+ans = H1 is 1 with p = 0.0005 so reject the null hypothesisthat there is 1 mode
 
-ans = H2 is 0 with p = 0.314 so accept the null hypothesis that there are 2 modes</pre>
+ans = H2 is 0 with p = 0.343 so accept the null hypothesis that there are 2 modes</pre>
 </div>
 
 <p>Package: <a href="../index.html">statistics-resampling</a></p>

diff --git a/docs/function/bootstrp.html b/docs/function/bootstrp.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-05-13"/>
+  <meta name="date" content="2024-05-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." />
@@ -109,10 +109,11 @@ <h2>bootstrp</h2>
      '[BOOTSTAT, BOOTSAM, STATS] = bootstrp (...)' also calculates and returns
      the following basic statistics relating to each column of BOOTSTAT: 
         - original: the original estimate(s) calculated by BOOTFUN and the DATA
-        - bias: bootstrap bias of the estimate(s)
+        - mean: the mean of the bootstrap distribution(s)
+        - bias: bootstrap estimate of the bias of the sampling distribution(s)
         - bias_corrected: original estimate(s) after subtracting the bias
         - var: bootstrap variance of the original estimate(s)
-        - std_error: bootstrap standard error of the original estimate(s)
+        - std_error: bootstrap estimate(s) of the standard error(s)
      If BOOTSTAT is not numeric, STATS only returns the 'original' field. If
      BOOTFUN is empty, then the value of the 'original' field is also empty.
 

diff --git a/docs/function/bootwild.html b/docs/function/bootwild.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-05-13"/>
+  <meta name="date" content="2024-05-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." />
@@ -42,7 +42,7 @@ <h2>bootwild</h2>
      p-values after imposing the null hypothesis (H0) [1-4]. The following
      statistics are printed to the standard output:
         - original: the mean of the data vector y
-        - std_err: heteroscedasticity-consistent standard error(s)
+        - std_err: heteroscedasticity-consistent standard error(s) (HC0)
         - CI_lower: lower bound(s) of the 95% bootstrap-t confidence interval
         - CI_upper: upper bound(s) of the 95% bootstrap-t confidence interval
         - tstat: Student's t-statistic
@@ -180,7 +180,7 @@ <h3><a name="1">Demonstration 1</a></h3>
 
 Test Statistics: 
  original     std_err      CI_lower     CI_upper     t-stat      p-val     FPR
- +184.5       +1.243       +181.6       +187.4       +148.       <.001    .010</pre>
+ +184.5       +1.243       +181.7       +187.3       +148.       <.001    .010</pre>
 </div>
 
 <h3><a name="2">Demonstration 2</a></h3>
@@ -218,8 +218,8 @@ <h3><a name="2">Demonstration 2</a></h3>
 
 Test Statistics: 
  original     std_err      CI_lower     CI_upper     t-stat      p-val     FPR
- +175.5       +2.502       +169.8       +181.2       +70.1       <.001    .010
- +0.1904      +0.08261     +0.003534    +0.3773      +2.31        .047    .280</pre>
+ +175.5       +2.502       +169.9       +181.1       +70.1       <.001    .010
+ +0.1904      +0.08261     +0.01031     +0.3705      +2.31        .039    .257</pre>
 </div>
 
 <p>Package: <a href="../index.html">statistics-resampling</a></p>

diff --git a/docs/function/cor.html b/docs/function/cor.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-05-13"/>
+  <meta name="date" content="2024-05-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/credint.html b/docs/function/credint.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-05-13"/>
+  <meta name="date" content="2024-05-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/deffcalc.html b/docs/function/deffcalc.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-05-13"/>
+  <meta name="date" content="2024-05-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/images/boot1way_701.png b/docs/function/images/boot1way_701.png
diff --git a/docs/function/images/boot1way_801.png b/docs/function/images/boot1way_801.png
diff --git a/docs/function/randtest.html b/docs/function/randtest.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-05-13"/>
+  <meta name="date" content="2024-05-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." />
@@ -146,8 +146,8 @@ <h3><a name="2">Demonstration 2</a></h3>
 <p>Produces the following output</p>
 <pre class="example">pval =
 
-      0.53148
-   0.00049014
+      0.53905
+       0.0002
 
 stat =
 

diff --git a/docs/function/randtest1.html b/docs/function/randtest1.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-05-13"/>
+  <meta name="date" content="2024-05-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/randtest2.html b/docs/function/randtest2.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-05-13"/>
+  <meta name="date" content="2024-05-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." />
@@ -162,9 +162,9 @@ <h3><a name="1">Demonstration 1</a></h3>
                            @(A, B) log (var (A) ./ var (B)))
 </pre>
 <p>Produces the following output</p>
-<pre class="example">pval = 0.3668
-pval = 0.2698
-pval = 0.30905</pre>
+<pre class="example">pval = 0.3526
+pval = 0.2718
+pval = 0.31043</pre>
 </div>
 
 <h3><a name="2">Demonstration 2</a></h3>

diff --git a/docs/function/sampszcalc.html b/docs/function/sampszcalc.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-05-13"/>
+  <meta name="date" content="2024-05-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/smoothmad.html b/docs/function/smoothmad.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-05-13"/>
+  <meta name="date" content="2024-05-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." />