update HTML documentation

gnu-octave · Feb 27, 2023 · 8a8e723 · 8a8e723
1 parent 13c63b6
commit 8a8e723
Show file tree

Hide file tree

Showing 59 changed files with 638 additions and 94 deletions.
diff --git a/docs/ConfusionMatrixChart.html b/docs/ConfusionMatrixChart.html
@@ -0,0 +1,184 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>Statistics: ConfusionMatrixChart</title>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css" integrity="sha512-1ycn6IcaQQ40/MKBW2W4Rhis/DbILU74C1vSrLJxCq57o941Ym01SwNsOMqvEBFlcgUa6xLiPY/NS5R+E6ztJQ==" crossorigin="anonymous" referrerpolicy="no-referrer">
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-KyZXEAg3QhqLMpG8r+8fhAXLRk2vvoC2f3B09zVXn8CA5QIVfZOJ3BCsw2P0p/We" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-U1DAWAznBHeqEIlVSCgzq+c9gqGAJn5c/t99JyeKa9xxaYpSvHU5awsuZVVFIhvj" crossorigin="anonymous"></script>
+    <script type="text/javascript" async
+      src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_CHTML">
+    </script>
+    <style>
+    var {
+      font-style: italics;
+      font-weight: bold;
+    }
+    td {
+      vertical-align: top;
+    }
+    </style>
+  </head>
+  <body>
+    <div class="bg-dark">
+      <div class="container-xl">
+        <nav class="navbar navbar-expand-lg navbar-dark bg-dark">
+          <div class="container-fluid">
+            <a class="navbar-brand" href=index.html>
+              <img src="assets/statistics.png" alt="statistics" class="d-inline-block align-top" width="25" height="25">
+              Statistics
+            </a>
+            <button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
+              <span class="navbar-toggler-icon"></span>
+            </button>
+            <div class="collapse navbar-collapse" id="navbarNav">
+              <ul class="navbar-nav">
+                <li class="nav-item">
+                  <a class="nav-link" href="index.html#Clustering">
+                    <i class="fas fa-list-alt"></i>
+                    Clustering
+                  </a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="https://gnu-octave.github.io/packages/">
+                  <img src="assets/octave-logo.svg" alt="GNU Octave logo" class="d-inline-block align-top" width="25" height="25">
+                    Octave Packages
+                  </a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="https://www.octave.org">
+                    <i class="fas fa-home"></i>
+                    GNU Octave website
+                  </a>
+                </li>
+              </ul>
+            </div>
+          </div>
+        </nav>
+      </div>
+    </div>
+    <div class="container-xl my-4">
+      <div class="card rounded">
+        <div class="card-header card-header-mod">
+          <div class="row d-flex flex-wrap align-items-center">
+            <div class="col-sm-3 col-md-5 mb-2 mb-sm-0">
+              <h3 class="d-inline-block mr-2">
+              Function&nbsp;Reference: <b><code>ConfusionMatrixChart</code></b>
+              </h3>
+            </div>
+          </div>
+        </div>
+        <div class="card-body">
+<dl>
+<dt><u>statistics:</u> <var>p</var> = <b>ConfusionMatrixChart</b><i> ()</i></dt>
+</dl>
+<p> Create object <var>p</var>, a Confusion Matrix Chart object.
+</p>
+<div class="ms-5">
+ <dl compact="compact">
+<dt> <code>&quot;DiagonalColor&quot;</code></dt>
+</dl>
+<p> The color of the patches on the diagonal, default is [0.0, 0.4471, 0.7412].
+</p>
+ </dd>
+<dt> <code>&quot;OffDiagonalColor&quot;</code></dt>
+</dl>
+<p> The color of the patches off the diagonal, default is [0.851, 0.3255, 0.098].
+</p>
+ </dd>
+<dt> <code>&quot;GridVisible&quot;</code></dt>
+</dl>
+<p> Available values: <code>on</code> (default), <code>off</code>.
+</p>
+ </dd>
+<dt> <code>&quot;Normalization&quot;</code></dt>
+</dl>
+<p> Available values: <code>absolute</code> (default), <code>column-normalized</code>,
+ <code>row-normalized</code>, <code>total-normalized</code>.
+</p>
+ </dd>
+<dt> <code>&quot;ColumnSummary&quot;</code></dt>
+</dl>
+<p> Available values: <code>off</code> (default), <code>absolute</code>,
+ <code>column-normalized</code>,<code>total-normalized</code>.
+</p>
+ </dd>
+<dt> <code>&quot;RowSummary&quot;</code></dt>
+</dl>
+<p> Available values: <code>off</code> (default), <code>absolute</code>,
+ <code>row-normalized</code>, <code>total-normalized</code>.
+ </p></dd>
+</dl>
+
+<p> MATLAB compatibility &ndash; the not implemented properties are: FontColor,
+ PositionConstraint, InnerPosition, Layout.
+</p>
+<p> <strong>See also: </strong>
+  <a href="confusionchart.html">confusionchart</a>
+</p>
+<p><strong>Source Code: </strong>
+  <a href="https://github.com/gnu-octave/statistics/tree/main/inst/ConfusionMatrixChart.m">ConfusionMatrixChart</a>
+</div>
+        <div class="container-xl my-4">
+          <div class="card rounded">
+            <div class="card-header card-header-mod">
+              <div class="row d-flex flex-wrap align-items-center">
+                <div class="col-sm-3 col-md-5 mb-2 mb-sm-0">
+                  <h3 class="d-inline-block mr-2">
+                  Example: 1
+                  </h3>
+                </div>
+              </div>
+            </div>
+            <div class="card-body">
+              <div class="container bg-light">
+                <div class="row">
+                  <table><tbody><tr>
+                    <td>&nbsp;</td>
+                    <td><pre class="example">
+
+ ## Create a simple ConfusionMatrixChart Object
+
+ cm = ConfusionMatrixChart (gca, [1 2; 1 2], {"A","B"},{"XLabel","LABEL A"})
+ NormalizedValues = cm.NormalizedValues
+ ClassLabels = cm.ClassLabels
+
+cm =
+
+ConfusionMatrixChart with properties:
+
+	NormalizedValues: [ 2x2 double ]
+	ClassLabels: { 1x2 cell }
+
+
+NormalizedValues =
+
+   1   2
+   1   2
+
+ClassLabels =
+{
+  [1,1] = A
+  [1,2] = B
+}
+
+                    </pre></td></tr></tbody>
+                  </table>
+                  <div class="text-center">
+                    <img src="assets/ConfusionMatrixChart_101.png" class="rounded img-thumbnail" alt="plotted figure">
+                  </div><p></p>
+
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+
+
+        </div>
+      </div>
+    </div>
+
+  </body>
+</html>
diff --git a/docs/anova1.html b/docs/anova1.html
@@ -186,9 +186,9 @@ <h3 class="d-inline-block mr-2">
 
 Source        SS      df        MS       F      Prob>F
 ------------------------------------------------------
-Groups    112.7223     5    22.5445    39.66    0.0000
-Error      17.0514    30     0.5684
-Total     129.7736    35
+Groups    128.9120     5    25.7824    34.13    0.0000
+Error      22.6632    30     0.7554
+Total     151.5752    35
 
                     </pre></td></tr></tbody>
                   </table>
@@ -226,9 +226,9 @@ <h3 class="d-inline-block mr-2">
 
 Source        SS      df        MS       F      Prob>F
 ------------------------------------------------------
-Groups    130.4467     5    26.0893    24.18    0.0000
-Error      32.3655    30     1.0788
-Total     162.8122    35
+Groups    102.5418     5    20.5084    14.39    0.0000
+Error      42.7504    30     1.4250
+Total     145.2923    35
 
                     </pre></td></tr></tbody>
                   </table>
@@ -270,9 +270,9 @@ <h3 class="d-inline-block mr-2">
 
 Source        SS      df        MS       F      Prob>F
 ------------------------------------------------------
-Groups   1215.8499     3   405.2833    99.45    0.0000
-Error     798.7834   196     4.0754
-Total    2014.6332   199
+Groups   1290.5622     3   430.1874   104.87    0.0000
+Error     803.9915   196     4.1020
+Total    2094.5537   199
 
                     </pre></td></tr></tbody>
                   </table>

diff --git a/docs/assets/ConfusionMatrixChart_101.png b/docs/assets/ConfusionMatrixChart_101.png
diff --git a/docs/assets/anova1_201.png b/docs/assets/anova1_201.png
diff --git a/docs/assets/anova1_301.png b/docs/assets/anova1_301.png
diff --git a/docs/assets/boxplot_101.png b/docs/assets/boxplot_101.png
diff --git a/docs/assets/boxplot_201.png b/docs/assets/boxplot_201.png
diff --git a/docs/assets/boxplot_301.png b/docs/assets/boxplot_301.png
diff --git a/docs/assets/boxplot_401.png b/docs/assets/boxplot_401.png
diff --git a/docs/assets/cdfplot_101.png b/docs/assets/cdfplot_101.png
diff --git a/docs/assets/clusterdata_101.png b/docs/assets/clusterdata_101.png
diff --git a/docs/assets/dcov_101.png b/docs/assets/dcov_101.png
diff --git a/docs/assets/dendrogram_201.png b/docs/assets/dendrogram_201.png
diff --git a/docs/assets/dendrogram_301.png b/docs/assets/dendrogram_301.png
diff --git a/docs/assets/dendrogram_401.png b/docs/assets/dendrogram_401.png
diff --git a/docs/assets/dendrogram_501.png b/docs/assets/dendrogram_501.png
diff --git a/docs/assets/ecdf_101.png b/docs/assets/ecdf_101.png
diff --git a/docs/assets/ecdf_201.png b/docs/assets/ecdf_201.png
diff --git a/docs/assets/fitgmdist_101.png b/docs/assets/fitgmdist_101.png
diff --git a/docs/assets/gscatter_101.png b/docs/assets/gscatter_101.png
diff --git a/docs/assets/histfit_101.png b/docs/assets/histfit_101.png
diff --git a/docs/assets/jackknife_101.png b/docs/assets/jackknife_101.png
diff --git a/docs/assets/jackknife_201.png b/docs/assets/jackknife_201.png
diff --git a/docs/assets/kmeans_101.png b/docs/assets/kmeans_101.png
diff --git a/docs/assets/kmeans_301.png b/docs/assets/kmeans_301.png
diff --git a/docs/assets/kmeans_302.png b/docs/assets/kmeans_302.png
diff --git a/docs/assets/kmeans_401.png b/docs/assets/kmeans_401.png
diff --git a/docs/assets/kruskalwallis_201.png b/docs/assets/kruskalwallis_201.png
diff --git a/docs/assets/kruskalwallis_301.png b/docs/assets/kruskalwallis_301.png
diff --git a/docs/assets/mhsample_101.png b/docs/assets/mhsample_101.png
diff --git a/docs/assets/multcompare_101.png b/docs/assets/multcompare_101.png
diff --git a/docs/assets/procrustes_101.png b/docs/assets/procrustes_101.png
diff --git a/docs/assets/regress_gp_101.png b/docs/assets/regress_gp_101.png
diff --git a/docs/assets/regress_gp_201.png b/docs/assets/regress_gp_201.png
diff --git a/docs/assets/regress_gp_301.png b/docs/assets/regress_gp_301.png
diff --git a/docs/assets/silhouette_101.png b/docs/assets/silhouette_101.png
diff --git a/docs/assets/slicesample_101.png b/docs/assets/slicesample_101.png
diff --git a/docs/assets/violin_101.png b/docs/assets/violin_101.png
diff --git a/docs/assets/violin_201.png b/docs/assets/violin_201.png
diff --git a/docs/assets/violin_301.png b/docs/assets/violin_301.png
diff --git a/docs/assets/violin_401.png b/docs/assets/violin_401.png
diff --git a/docs/assets/violin_501.png b/docs/assets/violin_501.png
diff --git a/docs/assets/violin_601.png b/docs/assets/violin_601.png
diff --git a/docs/chi2gof.html b/docs/chi2gof.html
@@ -187,66 +187,66 @@ <h3 class="d-inline-block mr-2">
  [h, p, stats] = chi2gof (x, "cdf", {@normcdf, mean(x), std(x)})
 
 h = 0
-p = 0.6088
+p = 0.2901
 stats =
 
   scalar structure containing the fields:
 
-    chi2stat = 3.5966
-    df = 5
+    chi2stat = 4.9724
+    df = 4
     edges =
 
-       38.745   43.644   46.093   48.542   50.991   53.440   55.890   58.339   63.237
+       38.717   43.567   45.992   48.417   50.842   53.266   55.691   62.966
 
     O =
 
-        5   10   17   15   16   20    9    8
+       11   15   13   15   22   11   13
 
     E =
 
-        6.2207    8.6230   14.2787   18.6262   19.1416   15.4972    9.8841    7.7284
+        9.3406   11.4470   17.1333   19.9541   18.0830   12.7512   11.2908
 
 
 h = 0
-p = 0.6088
+p = 0.2901
 stats =
 
   scalar structure containing the fields:
 
-    chi2stat = 3.5966
-    df = 5
+    chi2stat = 4.9724
+    df = 4
     edges =
 
-       38.745   43.644   46.093   48.542   50.991   53.440   55.890   58.339   63.237
+       38.717   43.567   45.992   48.417   50.842   53.266   55.691   62.966
 
     O =
 
-        5   10   17   15   16   20    9    8
+       11   15   13   15   22   11   13
 
     E =
 
-        6.2207    8.6230   14.2787   18.6262   19.1416   15.4972    9.8841    7.7284
+        9.3406   11.4470   17.1333   19.9541   18.0830   12.7512   11.2908
 
 
 h = 0
-p = 0.6088
+p = 0.2901
 stats =
 
   scalar structure containing the fields:
 
-    chi2stat = 3.5966
-    df = 5
+    chi2stat = 4.9724
+    df = 4
     edges =
 
-       38.745   43.644   46.093   48.542   50.991   53.440   55.890   58.339   63.237
+       38.717   43.567   45.992   48.417   50.842   53.266   55.691   62.966
 
     O =
 
-        5   10   17   15   16   20    9    8
+       11   15   13   15   22   11   13
 
     E =
 
-        6.2207    8.6230   14.2787   18.6262   19.1416   15.4972    9.8841    7.7284
+        9.3406   11.4470   17.1333   19.9541   18.0830   12.7512   11.2908
 
 
                     </pre></td></tr></tbody>
@@ -283,26 +283,26 @@ <h3 class="d-inline-block mr-2">
  [h, p, stats] = chi2gof (x, "binedges", binedges, "expected", expectedCounts)
 
 h = 0
-p = 0.4559
+p = 0.7399
 stats =
 
   scalar structure containing the fields:
 
-    chi2stat = 8.8000
+    chi2stat = 6.0000
     df = 9
     edges =
 
      Columns 1 through 7:
 
-       8.0469e-03   1.0609e-01   2.0414e-01   3.0218e-01   4.0022e-01   4.9827e-01   5.9631e-01
+       1.9129e-03   9.8803e-02   1.9569e-01   2.9258e-01   3.8947e-01   4.8636e-01   5.8325e-01
 
      Columns 8 through 11:
 
-       6.9436e-01   7.9240e-01   8.9044e-01   9.8849e-01
+       6.8014e-01   7.7703e-01   8.7392e-01   9.7081e-01
 
     O =
 
-       14    6   13    6    6   11   13   10    9   12
+       10    9    7   14   14    6   10   10    9   11
 
     E =