update online manual

gnu-octave · May 19, 2024 · 162a876 · 162a876
1 parent 672b37e
commit 162a876
Show file tree

Hide file tree

Showing 15 changed files with 122 additions and 53 deletions.
diff --git a/docs/function/boot.html b/docs/function/boot.html
@@ -118,21 +118,21 @@ <h3><a name="1">Demonstration 1</a></h3>
 
  Columns 1 through 8:
 
-            3            1            3            1            1            1            3            3
-            3            1            3            2            1            1            2            3
-            3            2            2            2            1            3            2            3
+            2            3            3            2            2            2            1            1
+            3            1            3            1            2            3            2            2
+            2            1            3            3            2            1            2            3
 
  Columns 9 through 16:
 
-            3            1            3            2            2            2            2            3
-            1            2            3            1            2            2            1            1
-            2            1            3            2            3            2            1            3
+            3            1            3            3            2            1            2            2
+            2            1            2            1            2            2            3            3
+            1            2            1            2            3            1            1            1
 
  Columns 17 through 20:
 
-            1            1            2            1
-            3            3            2            2
-            3            1            1            2</pre>
+            3            3            1            1
+            1            1            3            3
+            2            3            3            1</pre>
 </div>
 
 <h3><a name="2">Demonstration 2</a></h3>
@@ -147,21 +147,21 @@ <h3><a name="2">Demonstration 2</a></h3>
 
  Columns 1 through 8:
 
-            2            3            1            2            1            2            3            1
-            3            1            2            2            1            2            3            1
-            3            3            1            3            1            2            3            3
+            2            3            2            2            3            1            3            1
+            2            1            1            2            3            2            2            1
+            3            3            1            2            3            1            3            1
 
  Columns 9 through 16:
 
-            2            3            1            1            3            3            2            2
-            1            3            1            2            2            3            2            3
-            2            2            1            2            3            1            1            3
+            2            2            1            2            2            3            1            2
+            1            3            3            1            3            3            1            2
+            2            2            3            2            3            1            1            3
 
  Columns 17 through 20:
 
-            1            2            2            2
-            1            1            3            1
-            1            2            3            3</pre>
+            1            2            3            3
+            1            1            1            2
+            3            1            3            2</pre>
 </div>
 
 <h3><a name="3">Demonstration 3</a></h3>

diff --git a/docs/function/boot1way.html b/docs/function/boot1way.html
@@ -529,7 +529,7 @@ <h3><a name="7">Demonstration 7</a></h3>
 -----------------------------------------------------------------------------
 | Comparison |     Test # |      Ref # | Difference |          t |        p |
 |------------|------------|------------|------------|------------|----------|
-|          1 |          2 |          1 |    -0.8075 |      -1.78 |     .087 |
+|          1 |          2 |          1 |    -0.9797 |      -2.64 |     .035 |*
 
 -----------------------------------------------------------------------------
 |    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.5106 |      -0.80 |     .241 |
+|          1 |          2 |          1 |     -1.212 |      -1.15 |     .088 |
 
 -----------------------------------------------------------------------------
 |    GROUP # |                                       GROUP label |        N |

diff --git a/docs/function/bootbayes.html b/docs/function/bootbayes.html
@@ -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.02607     +184.5       1.325       +181.9        +187.1</pre>
+ +184.5       -0.02316     +184.5       1.349       +181.7        +187.1</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.1068      +175.4       2.360       +170.5        +179.9    
- +0.1904      +0.002915    +0.1944      0.07831     +0.04770      +0.3512</pre>
+ +175.5       -0.1144      +175.4       2.342       +171.4        +180.4    
+ +0.1904      +0.002996    +0.1936      0.07780     +0.03952      +0.3372</pre>
 </div>
 
 <p>Package: <a href="../index.html">statistics-resampling</a></p>

diff --git a/docs/function/bootci.html b/docs/function/bootci.html
@@ -468,8 +468,8 @@ <h3><a name="10">Demonstration 10</a></h3>
 <p>Produces the following output</p>
 <pre class="example">ci =
 
-      -0.7335     -0.65456
-       0.2701      0.11194</pre>
+    -0.011714     -0.22144
+       0.6564      0.31204</pre>
 </div>
 
 <h3><a name="11">Demonstration 11</a></h3>

diff --git a/docs/function/bootclust.html b/docs/function/bootclust.html
@@ -376,8 +376,8 @@ <h3><a name="7">Demonstration 7</a></h3>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- -0.02393     -0.005070    +0.2148      -0.3921      +0.3147    
- -0.2107      -0.01181     +0.2051      -0.5857      +0.08041</pre>
+ +0.3007      +0.007771    +0.2331      -0.1203      +0.6520    
+ -0.01086     +0.01519     +0.2865      -0.4592      +0.4696</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.2322      -0.04780     +0.2826      -0.2088      +0.7356    
- +0.004256    +0.02352     +0.3034      -0.4945      +0.5023</pre>
+ +0.1979      +0.001085    +0.1415      -0.05864     +0.4100    
+ +0.1593      +0.01669     +0.07158     +0.02569     +0.2652</pre>
 </div>
 
 <h3><a name="9">Demonstration 9</a></h3>

diff --git a/docs/function/bootint.html b/docs/function/bootint.html
@@ -20,19 +20,20 @@
 <div id="doccontent">
 
 <h2>bootint</h2>
-<pre> Computes simple percentile confidence interval(s) directly from a vector (or
- row-major matrix) of bootstrap statistics.
+<pre> Computes percentile confidence interval(s) directly from a vector (or row-
+ major matrix) of bootstrap statistics.
 
  -- Function File: CI = bootint (BOOTSTAT)
  -- Function File: CI = bootint (BOOTSTAT, PROB)
+ -- Function File: CI = bootint (BOOTSTAT, PROB, ORIGINAL)
 
-     'CI = bootint (BOOTSTAT)' computes 95% percentile confidence intervals
-     directly from the vector, or rows* of the matrix in BOOTSTAT, where
-     BOOTSTAT contains bootstrap statistics such as those generated using
-     the `bootstrp` function. Depending on the application, bootstrap
-     confidence intervals with better coverage and accuracy can be computed
-     using the various dedicated bootstrap functions from the statistics-
-     resampling package.
+     'CI = bootint (BOOTSTAT)' computes simple 95% percentile confidence
+     intervals [1,2] directly from the vector, or rows* of the matrix in
+     BOOTSTAT, where BOOTSTAT contains bootstrap statistics such as those
+     generated using the `bootstrp` function. Depending on the application,
+     bootstrap confidence intervals with better coverage and accuracy can
+     be computed using the various dedicated bootstrap confidence interval
+     functions from the statistics-resampling package.
 
         * The matrix should have dimensions P * NBOOT, where P corresponds to
           the number of parameter estimates and NBOOT corresponds to the number
@@ -50,7 +51,22 @@ <h2>bootint</h2>
           The default value of PROB is the vector: [0.025, 0.975], for an
           equal-tailed 95% percentile confidence interval.
 
-  bootint (version 2024.04.24)
+     'CI = bootint (BOOTSTAT, PROB, ORIGINAL)' uses the ORIGINAL estimates
+     associated with BOOTSTAT to correct PROB and the resulting confidence
+     intervals (CI) for median bias. The confidence intervals returned in CI
+     therefore become bias-corrected percentile intervals [3,4].
+
+  BIBLIOGRAPHY:
+  [1] Efron (1979) Bootstrap Methods: Another look at the jackknife.
+        Annals Stat. 7,1-26
+  [2] Efron, and Tibshirani (1993) An Introduction to the Bootstrap. 
+        New York, NY: Chapman & Hall
+  [3] Efron (1981) Nonparametric Standard Errors and Confidence Intervals.
+        Can J Stat. 9(2):139-172
+  [4] Efron (1982) The jackknife, the bootstrap, and other resampling plans.
+        SIAM-NSF, CBMS #38
+
+  bootint (version 2024.05.19)
   Author: Andrew Charles Penn
   https://www.researchgate.net/profile/Andrew_Penn/
 
@@ -69,6 +85,35 @@ <h2>bootint</h2>
   along with this program.  If not, see http://www.gnu.org/licenses/
 </pre>
 
+<h3><a name="1">Demonstration 1</a></h3>
+<div class="demo">
+<p>The following code</p>
+<pre class="example">
+
+ % Law school data
+ data = [576, 3.39; 635, 3.30; 558, 2.81; 578, 3.03; 666, 3.44; ...
+         580, 3.07; 555, 3.00; 661, 3.43; 661, 3.36; 605, 3.13; ...
+         653, 3.12; 575, 2.74; 545, 2.76; 572, 2.88; 594, 2.96];
+ x = data(:, 1);
+ y = data(:, 2);
+ r = cor (x, y);
+
+ % 95% confidence interval for the mean 
+ bootstat = bootstrp (4999, @cor, x, y);
+ CI_per  = bootint (bootstat,0.95)    % 95% simple percentile interval
+ CI_cper = bootint (bootstat,0.95,r)  % 95% bias-corrected percentile interval
+
+ % Please be patient, the calculations will be completed soon...</pre>
+<p>Produces the following output</p>
+<pre class="example">CI_per =
+
+      0.45985      0.96204
+
+CI_cper =
+
+      0.41869      0.95609</pre>
+</div>
+
 <p>Package: <a href="../index.html">statistics-resampling</a></p>
 </div>
 </body>

diff --git a/docs/function/bootknife.html b/docs/function/bootknife.html
@@ -442,8 +442,8 @@ <h3><a name="8">Demonstration 8</a></h3>
 
 Bootstrap Statistics: 
  original     bias         std_error    CI_lower     CI_upper  
- +0.09963     +0.02100     +0.2600      -0.4205      +0.4600    
- +0.3130      -0.01524     +0.3128      -0.2219      +0.8042</pre>
+ +0.1519      +0.03478     +0.2451      -0.2481      +0.5271    
+ +0.2824      +0.01686     +0.2437      -0.08981     +0.6853</pre>
 </div>
 
 <h3><a name="9">Demonstration 9</a></h3>

diff --git a/docs/function/bootmode.html b/docs/function/bootmode.html
@@ -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.0005 so reject the null hypothesisthat there is 1 mode
+ans = H1 is 1 with p = 0 so reject the null hypothesisthat there is 1 mode
 
-ans = H2 is 0 with p = 0.334 so accept the null hypothesis that there are 2 modes</pre>
+ans = H2 is 0 with p = 0.326 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/bootwild.html b/docs/function/bootwild.html
@@ -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.6       +181.4       +70.1       <.001    .010
- +0.1904      +0.08261     -0.002902    +0.3837      +2.31        .053    .298</pre>
+ +175.5       +2.502       +169.8       +181.2       +70.1       <.001    .010
+ +0.1904      +0.08261     +0.005631    +0.3752      +2.31        .046    .277</pre>
 </div>
 
 <p>Package: <a href="../index.html">statistics-resampling</a></p>

diff --git a/docs/function/credint.html b/docs/function/credint.html
@@ -74,6 +74,30 @@ <h2>credint</h2>
   along with this program.  If not, see http://www.gnu.org/licenses/
 </pre>
 
+<h3><a name="1">Demonstration 1</a></h3>
+<div class="demo">
+<p>The following code</p>
+<pre class="example">
+
+ % Input univariate dataset
+ heights = [183, 192, 182, 183, 177, 185, 188, 188, 182, 185].';
+
+ % 95% credible interval for the mean 
+ [stats, bootstat] = bootbayes (heights);
+ CI = credint (bootstat,0.95)           % 95% shortest probability interval
+ CI = credint (bootstat,[0.025,0.975])  % 95% equal-tailed interval
+
+ % Please be patient, the calculations will be completed soon...</pre>
+<p>Produces the following output</p>
+<pre class="example">CI =
+
+       181.92       187.09
+
+CI =
+
+        181.9       187.08</pre>
+</div>
+
 <p>Package: <a href="../index.html">statistics-resampling</a></p>
 </div>
 </body>

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
@@ -146,8 +146,8 @@ <h3><a name="2">Demonstration 2</a></h3>
 <p>Produces the following output</p>
 <pre class="example">pval =
 
-      0.54748
-   0.00034059
+      0.52197
+       0.0002
 
 stat =
 
@@ -173,7 +173,7 @@ <h3><a name="3">Demonstration 3</a></h3>
  % of standardized x and y values.
  [pval, stat] = randtest (X, Y, 5000, @cor)</pre>
 <p>Produces the following output</p>
-<pre class="example">pval = 0.00039059
+<pre class="example">pval = 0.00079237
 stat = 0.72317</pre>
 </div>
 

diff --git a/docs/function/randtest2.html b/docs/function/randtest2.html
@@ -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.3594
-pval = 0.2814
-pval = 0.3108</pre>
+<pre class="example">pval = 0.3518
+pval = 0.2802
+pval = 0.3068</pre>
 </div>
 
 <h3><a name="2">Demonstration 2</a></h3>

diff --git a/docs/function_reference.html b/docs/function_reference.html
@@ -81,7 +81,7 @@ <h3 class="category"><a name="Utility_Functions">Utility Functions</a></h3>
     <div class="ftext"> Computes the empirical cumulative distribution function (ECDF), accounting for  the presence of ties.</div>
 
     <div class="func"><b><a href="function/bootint.html">bootint</a></b></div>
-    <div class="ftext"> Computes simple percentile confidence interval(s) directly from a vector (or  row-major matrix) of bootstrap statistics.</div>
+    <div class="ftext"> Computes percentile confidence interval(s) directly from a vector (or row-  major matrix) of bootstrap statistics.</div>
 
     <div class="func"><b><a href="function/credint.html">credint</a></b></div>
     <div class="ftext"> Computes credible interval(s) directly from a vector (or row-major matrix) of  the posterior(s) obtained by bayesian bootstrap.</div>