Moved manual to docs folder and publish page using GitHub pages

README.md

@@ -46,7 +46,7 @@ To install (or test) the statistics-resampling package at it's existing location
 
 ### Usage
 
-All help and demos are documented on the 'Function Reference' page in the documentation. For the best experience navigating the manual, please ensure that javascript is enabled in your browser.
+All help and demos are documented on the 'Function Reference' page in the [manual](https://gnu-octave.github.io/statistics-resampling/). If you do not see the navigation pane on the manual web pages, please enable javascript in your browser.
 
 Function help can also be requested from the Octave/MATLAB command prompt, by typing `help function-name`. 
 

docs/description.json

@@ -5,10 +5,10 @@
   "package": 
   {
     "name": "statistics-resampling",
-    "version": "5.5.3",
+    "version": "5.5.4",
     "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-03",
+    "date": "2024-01-04",
     "title": "A statistics package with a variety of resampling tools",
     "author": "Andrew Penn <[email protected]>",
     "maintainer": "Andrew Penn <[email protected]>",
@@ -33,7 +33,7 @@
       "has_index": true,
       "has_license": true,
       "has_website_files": true,
-      "has_demos": false
+      "has_demos": true
     },
     "paths": 
     {

docs/function/boot.html

@@ -100,6 +100,120 @@
   You should have received a copy of the GNU General Public License
   along with this program.  If not, see http://www.gnu.org/licenses/
 </pre>
+<h2>Demonstration 1</h2>
+<div class="demo">
+<p>The following code</p>
+<pre class="example">
+
+ % N as input; balanced bootstrap resampling with replacement
+ boot(3, 20, false)</pre>
+<p>Produces the following output</p>
+<pre class="example">ans =
+
+   2   2   3   3   1   1   2   2   3   2   2   3   3   1   3   2   1   2   3   1
+   2   3   3   2   1   1   1   2   3   3   3   1   1   2   3   3   2   1   1   2
+   3   2   3   3   2   2   2   1   3   3   1   1   1   1   2   1   2   1   3   1</pre>
+</div>
+<h2>Demonstration 2</h2>
+<div class="demo">
+<p>The following code</p>
+<pre class="example">
+
+ % N as input; (unbiased) balanced bootknife resampling with replacement
+ boot(3, 20, true)</pre>
+<p>Produces the following output</p>
+<pre class="example">ans =
+
+   3   3   2   3   1   2   2   1   1   3   3   1   2   3   2   2   1   2   2   3
+   2   1   1   2   1   1   3   1   1   3   3   2   3   1   1   3   1   2   2   2
+   2   3   1   3   3   2   3   1   1   3   3   1   3   3   1   2   1   2   2   2</pre>
+</div>
+<h2>Demonstration 3</h2>
+<div class="demo">
+<p>The following code</p>
+<pre class="example">
+
+ % N as input; balanced resampling with replacement; setting the random seed
+ boot(3, 20, false, 1) % Set random seed
+ boot(3, 20, false, 1) % Reset random seed, BOOTSAM is the same
+ boot(3, 20, false)    % Without setting random seed, BOOTSAM is different</pre>
+<p>Produces the following output</p>
+<pre class="example">ans =
+
+   3   3   3   3   1   2   3   3   1   1   2   2   1   2   2   2   1   2   1   1
+   3   1   2   2   3   1   3   1   2   2   3   3   2   3   3   3   3   1   1   2
+   3   2   3   1   3   1   1   1   3   1   2   3   2   1   2   2   2   1   2   1
+
+ans =
+
+   3   3   3   3   1   2   3   3   1   1   2   2   1   2   2   2   1   2   1   1
+   3   1   2   2   3   1   3   1   2   2   3   3   2   3   3   3   3   1   1   2
+   3   2   3   1   3   1   1   1   3   1   2   3   2   1   2   2   2   1   2   1
+
+ans =
+
+   3   2   2   3   2   3   1   2   2   3   1   2   3   1   2   3   2   3   2   3
+   1   3   1   1   2   3   3   3   1   2   1   1   2   1   3   1   1   3   3   2
+   1   3   3   1   1   1   2   3   2   2   2   1   2   3   3   1   1   2   2   1</pre>
+</div>
+<h2>Demonstration 4</h2>
+<div class="demo">
+<p>The following code</p>
+<pre class="example">
+ % Vector (X) as input; balanced resampling with replacement; setting weights
+ x = [23; 44; 36];
+ boot(x, 10, false, 1)            % equal weighting
+ boot(x, 10, false, 1, [20;0;10]) % unequal weighting, no x(2) in BOOTSAM </pre>
+<p>Produces the following output</p>
+<pre class="example">ans =
+
+   44   23   23   36   44   23   44   36   36   23
+   36   23   36   23   44   36   36   23   44   44
+   36   36   23   44   23   44   23   36   44   44
+
+ans =
+
+   23   23   23   36   23   23   23   36   36   23
+   36   23   36   23   23   36   36   23   23   23
+   36   36   23   23   23   23   23   36   23   23</pre>
+</div>
+<h2>Demonstration 5</h2>
+<div class="demo">
+<p>The following code</p>
+<pre class="example">
+
+ % N as input; resampling without replacement; 3 trials
+ boot(6, 1, false, 1) % Sample 1; Set random seed for first sample only
+ boot(6, 1, false)    % Sample 2
+ boot(6, 1, false)    % Sample 3</pre>
+<p>Produces the following output</p>
+<pre class="example">ans =
+
+   4
+   2
+   3
+   5
+   4
+   6
+
+ans =
+
+   4
+   3
+   4
+   6
+   6
+   2
+
+ans =
+
+   5
+   6
+   3
+   4
+   1
+   6</pre>
+</div>
 
 <p>Package: <a href="../index.html">statistics-resampling</a></p>
 </div>