first draft of the paper

README.md

@@ -8,7 +8,8 @@ calzone is a comprehensive Python package for calculating and visualizing variou
 - Supports multiple calibration metrics including Spiegelhalter's Z-test, Expected Calibration Error (ECE), Maximum Calibration Error (MCE), Hosmer-Lemeshow test, Cox regression analysis, and Loess regression analysis
 - Provides tools for creating reliability diagrams and ROC curves
 - Offers both equal-space and equal-frequency binning options
-- Supports binary and multi-class classification problems
+- Boostrapping for confidence intervals for each calibration metrics
+- Prevelance adjustment to account for prevalance change between enriched data and population data.
 
 ## Installation
 

docs/build/html/_modules/calzone/metrics.html

@@ -55,6 +55,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/_modules/calzone/utils.html

@@ -55,6 +55,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/_modules/calzone/vis.html

@@ -55,6 +55,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/_modules/index.html

@@ -55,6 +55,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../notebooks/spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks/prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/_sources/index.rst.txt

@@ -39,4 +39,5 @@ We hope you find calzone useful in your machine learning projects!
    notebooks/spiegelhalter_z.ipynb
    notebooks/prevalence_adjustment.ipynb
    notebooks/subgroup.ipynb
+   notebooks/GUI.ipynb
    modules

docs/build/html/calzone.html

@@ -57,6 +57,7 @@
 <li class="toctree-l1"><a class="reference internal" href="notebooks/spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="modules.html">calzone</a><ul class="current">
 <li class="toctree-l2 current"><a class="current reference internal" href="#">calzone package</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>

docs/build/html/genindex.html

@@ -55,6 +55,7 @@
 <li class="toctree-l1"><a class="reference internal" href="notebooks/spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">calzone</a></li>
 </ul>
 

docs/build/html/index.html

@@ -59,6 +59,7 @@
 <li class="toctree-l1"><a class="reference internal" href="notebooks/spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">calzone</a></li>
 </ul>
 
@@ -170,6 +171,7 @@ <h1>Welcome to the documentation for calzone<a class="headerlink" href="#welcome
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">calzone</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="calzone.html">calzone package</a></li>
 </ul>

docs/build/html/modules.html

@@ -23,7 +23,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="calzone package" href="calzone.html" />
-    <link rel="prev" title="Subgroup analysis" href="notebooks/subgroup.html" /> 
+    <link rel="prev" title="Running GUI" href="notebooks/GUI.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -58,6 +58,7 @@
 <li class="toctree-l1"><a class="reference internal" href="notebooks/spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">calzone</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="calzone.html">calzone package</a></li>
 </ul>
@@ -163,7 +164,7 @@ <h1>calzone<a class="headerlink" href="#calzone" title="Link to this heading">
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="notebooks/subgroup.html" class="btn btn-neutral float-left" title="Subgroup analysis" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="notebooks/GUI.html" class="btn btn-neutral float-left" title="Running GUI" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="calzone.html" class="btn btn-neutral float-right" title="calzone package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

docs/build/html/notebooks/GUI.html

@@ -24,7 +24,9 @@
         <script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
-    <link rel="search" title="Search" href="../search.html" /> 
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="calzone" href="../modules.html" />
+    <link rel="prev" title="Subgroup analysis" href="subgroup.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -47,7 +49,7 @@
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
-<ul>
+<ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../index.html">Welcome to the documentation for calzone</a></li>
 <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="metrics_summary.html">Summary and guide for calzone</a></li>
@@ -59,6 +61,7 @@
 <li class="toctree-l1"><a class="reference internal" href="spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1 current"><a class="current reference internal" href="#">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 
@@ -111,7 +114,10 @@ <h1>Running GUI<a class="headerlink" href="#Running-GUI" title="Link to this hea
 
            </div>
           </div>
-          <footer>
+          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
+        <a href="subgroup.html" class="btn btn-neutral float-left" title="Subgroup analysis" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="../modules.html" class="btn btn-neutral float-right" title="calzone" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+    </div>
 
   <hr/>
 

docs/build/html/notebooks/cox.html

@@ -69,6 +69,7 @@
 <li class="toctree-l1"><a class="reference internal" href="spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/notebooks/ece_mce.html

@@ -72,6 +72,7 @@
 <li class="toctree-l1"><a class="reference internal" href="spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/notebooks/hl_test.html

@@ -69,6 +69,7 @@
 <li class="toctree-l1"><a class="reference internal" href="spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/notebooks/ici.html

@@ -69,6 +69,7 @@
 <li class="toctree-l1"><a class="reference internal" href="spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/notebooks/metrics_summary.html

@@ -63,6 +63,7 @@
 <li class="toctree-l1"><a class="reference internal" href="spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/notebooks/prevalence_adjustment.html

@@ -66,6 +66,7 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/notebooks/quickstart.html

@@ -66,6 +66,7 @@
 <li class="toctree-l1"><a class="reference internal" href="spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/notebooks/reliability_diagram.html

@@ -64,6 +64,7 @@
 <li class="toctree-l1"><a class="reference internal" href="spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/notebooks/spiegelhalter_z.html

@@ -69,6 +69,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 

docs/build/html/notebooks/subgroup.html

@@ -25,7 +25,7 @@
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="calzone" href="../modules.html" />
+    <link rel="next" title="Running GUI" href="GUI.html" />
     <link rel="prev" title="Prevalence adjustment" href="prevalence_adjustment.html" /> 
 </head>
 
@@ -61,6 +61,7 @@
 <li class="toctree-l1"><a class="reference internal" href="spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">calzone</a></li>
 </ul>
 
@@ -297,7 +298,7 @@ <h1>Subgroup analysis<a class="headerlink" href="#Subgroup-analysis" title="Link
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="prevalence_adjustment.html" class="btn btn-neutral float-left" title="Prevalence adjustment" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="../modules.html" class="btn btn-neutral float-right" title="calzone" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="GUI.html" class="btn btn-neutral float-right" title="Running GUI" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

docs/build/html/py-modindex.html

@@ -58,6 +58,7 @@
 <li class="toctree-l1"><a class="reference internal" href="notebooks/spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">calzone</a></li>
 </ul>
 

docs/build/html/search.html

@@ -58,6 +58,7 @@
 <li class="toctree-l1"><a class="reference internal" href="notebooks/spiegelhalter_z.html">Spiegelhalter’s Z-test</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/prevalence_adjustment.html">Prevalence adjustment</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/subgroup.html">Subgroup analysis</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/GUI.html">Running GUI</a></li>
 <li class="toctree-l1"><a class="reference internal" href="modules.html">calzone</a></li>
 </ul>
 

docs/build/latex/calzone.tex

@@ -65,7 +65,7 @@
 
 
 \title{calzone}
-\date{Oct 03, 2024}
+\date{Oct 04, 2024}
 \release{develop}
 \author{Kwok Lung Jason Fan}
 \newcommand{\sphinxlogo}{\vbox{}}
@@ -3162,6 +3162,37 @@ \chapter{Subgroup analysis}
 \sphinxstepscope
 
 
+\chapter{Running GUI}
+\label{\detokenize{notebooks/GUI:Running-GUI}}\label{\detokenize{notebooks/GUI::doc}}
+\sphinxAtStartPar
+To run GUI, you need to install nicegui using the following command:
+
+\begin{sphinxuseclass}{nbinput}
+\begin{sphinxuseclass}{nblast}
+{
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\llap{\color{nbsphinxin}[ ]:\,\hspace{\fboxrule}\hspace{\fboxsep}}\PYG{n}{pip} \PYG{n}{install} \PYG{n}{nicegui}
+\end{sphinxVerbatim}
+}
+
+\end{sphinxuseclass}
+\end{sphinxuseclass}
+\sphinxAtStartPar
+Then simply run the following command on calzone directory:
+
+\begin{sphinxuseclass}{nbinput}
+\begin{sphinxuseclass}{nblast}
+{
+\begin{sphinxVerbatim}[commandchars=\\\{\}]
+\llap{\color{nbsphinxin}[ ]:\,\hspace{\fboxrule}\hspace{\fboxsep}}\PYG{n}{python} \PYG{n}{GUI\PYGZus{}cal\PYGZus{}metric}\PYG{o}{.}\PYG{n}{py}
+\end{sphinxVerbatim}
+}
+
+\end{sphinxuseclass}
+\end{sphinxuseclass}
+\sphinxstepscope
+
+
 \chapter{calzone}
 \label{\detokenize{modules:calzone}}\label{\detokenize{modules::doc}}
 \sphinxstepscope

docs/source/index.rst

@@ -39,4 +39,5 @@ We hope you find calzone useful in your machine learning projects!
    notebooks/spiegelhalter_z.ipynb
    notebooks/prevalence_adjustment.ipynb
    notebooks/subgroup.ipynb
+   notebooks/GUI.ipynb
    modules