Typos in docs

DIDSR · Oct 4, 2024 · 86c6bf3 · 86c6bf3
1 parent 2e6ba0c
commit 86c6bf3
Show file tree

Hide file tree

Showing 28 changed files with 55 additions and 54 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 60b1671d767ce078b60d04f97ee74180
+config: 469a60082bbf876e15d311446f024954
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_modules/calzone/metrics.html b/docs/build/html/_modules/calzone/metrics.html
@@ -693,7 +693,7 @@ <h1>Source code for calzone.metrics</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/_modules/calzone/utils.html b/docs/build/html/_modules/calzone/utils.html
@@ -552,7 +552,7 @@ <h1>Source code for calzone.utils</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/_modules/calzone/vis.html b/docs/build/html/_modules/calzone/vis.html
@@ -260,7 +260,7 @@ <h1>Source code for calzone.vis</h1><div class="highlight"><pre>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -95,7 +95,7 @@ <h1>All modules for which code is available</h1>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/calzone.html b/docs/build/html/calzone.html
@@ -995,7 +995,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -344,7 +344,7 @@ <h2 id="S">S</h2>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/index.html b/docs/build/html/index.html
@@ -190,7 +190,7 @@ <h1>Welcome to the documentation for calzone<a class="headerlink" href="#welcome
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/modules.html b/docs/build/html/modules.html
@@ -171,7 +171,7 @@ <h1>calzone<a class="headerlink" href="#calzone" title="Link to this heading">
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/GUI.html b/docs/build/html/notebooks/GUI.html
@@ -122,7 +122,7 @@ <h1>Running GUI<a class="headerlink" href="#Running-GUI" title="Link to this hea
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/cox.html b/docs/build/html/notebooks/cox.html
@@ -362,7 +362,7 @@ <h2>References<a class="headerlink" href="#References" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/ece_mce.html b/docs/build/html/notebooks/ece_mce.html
@@ -313,7 +313,7 @@ <h2>Reference<a class="headerlink" href="#Reference" title="Link to this heading
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/hl_test.html b/docs/build/html/notebooks/hl_test.html
@@ -329,7 +329,7 @@ <h2>Reference<a class="headerlink" href="#Reference" title="Link to this heading
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/ici.html b/docs/build/html/notebooks/ici.html
@@ -283,7 +283,7 @@ <h2>Reference<a class="headerlink" href="#Reference" title="Link to this heading
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/metrics_summary.html b/docs/build/html/notebooks/metrics_summary.html
@@ -117,7 +117,7 @@ <h2>Guide to calzone and calibration metrics<a class="headerlink" href="#Guide-t
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/prevalence_adjustment.html b/docs/build/html/notebooks/prevalence_adjustment.html
@@ -274,7 +274,7 @@ <h2>References<a class="headerlink" href="#References" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/quickstart.html b/docs/build/html/notebooks/quickstart.html
@@ -535,7 +535,7 @@ <h2>Using calzone in python<a class="headerlink" href="#Using-calzone-in-python"
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/reliability_diagram.html b/docs/build/html/notebooks/reliability_diagram.html
@@ -230,7 +230,7 @@ <h2>References<a class="headerlink" href="#References" title="Link to this headi
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/spiegelhalter_z.html b/docs/build/html/notebooks/spiegelhalter_z.html
@@ -269,7 +269,7 @@ <h2>Reference<a class="headerlink" href="#Reference" title="Link to this heading
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/notebooks/subgroup.html b/docs/build/html/notebooks/subgroup.html
@@ -304,7 +304,7 @@ <h1>Subgroup analysis<a class="headerlink" href="#Subgroup-analysis" title="Link
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html
@@ -127,7 +127,7 @@ <h1>Python Module Index</h1>
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/html/search.html b/docs/build/html/search.html
@@ -105,7 +105,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2024, Kwok Lung &#34;Jason&#34; Fan.</p>
+    <p>&#169; Copyright No copyright.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/build/latex/calzone.fdb_latexmk b/docs/build/latex/calzone.fdb_latexmk
@@ -1,10 +1,10 @@
 # Fdb version 3
-["makeindex calzone.idx"] 1728064850 "calzone.idx" "calzone.ind" "calzone" 1728064853
-  "calzone.idx" 1728065764 7232 cc8d790ec4b65b5f815a2c3f9704d41c "pdflatex"
+["makeindex calzone.idx"] 1728067555 "calzone.idx" "calzone.ind" "calzone" 1728067558
+  "calzone.idx" 1728068469 7232 cc8d790ec4b65b5f815a2c3f9704d41c "pdflatex"
   (generated)
-  "calzone.ilg"
   "calzone.ind"
-["pdflatex"] 1728064852 "calzone.tex" "calzone.pdf" "calzone" 1728064853
+  "calzone.ilg"
+["pdflatex"] 1728067556 "calzone.tex" "calzone.pdf" "calzone" 1728067558
   "/etc/texmf/web2c/texmf.cnf" 1728063259 475 c0e671620eb5563b2130f56340a5fde8 ""
   "/home/kwoklung.fan/.texlive2019/texmf-var/web2c/pdftex/pdflatex.fmt" 1728065444 8258469 f9aaee64b5629d9cdd5c82d0cd0a36eb ""
   "/usr/share/texlive/texmf-dist/fonts/enc/dvips/base/8r.enc" 1165713224 4850 80dc9bab7f31fb78a000ccfed0e27cab ""
@@ -174,29 +174,29 @@
   "/usr/share/texmf/tex/latex/tex-gyre/tgtermes.sty" 1480098840 2211 af9b7d12507105a58a3e8e926996b827 ""
   "/usr/share/texmf/tex/latex/tex-gyre/ts1qtm.fd" 1480098840 1160 de7b1cf70edab73c9f1704df2a9fdbbd ""
   "/usr/share/texmf/web2c/texmf.cnf" 1581979058 38841 ce3692aa899bb693b90b87eaa5d4d84e ""
-  "calzone.aux" 1728065764 21648 e339e1176527f899af39f1851ea7620f "pdflatex"
-  "calzone.ind" 1728065761 5240 42886f6f60209394710627bf2365854b "makeindex calzone.idx"
-  "calzone.out" 1728065764 10869 1ba50f57c904cd05282ba32701e652cf "pdflatex"
-  "calzone.tex" 1728065759 252514 088357f147729462082e582be1db43d6 ""
-  "calzone.toc" 1728065764 5158 f53adb573b8b63b9d6f6abf5dac11d8e "pdflatex"
+  "calzone.aux" 1728068469 21648 e339e1176527f899af39f1851ea7620f "pdflatex"
+  "calzone.ind" 1728068466 5240 42886f6f60209394710627bf2365854b "makeindex calzone.idx"
+  "calzone.out" 1728068469 10869 1ba50f57c904cd05282ba32701e652cf "pdflatex"
+  "calzone.tex" 1728068464 252514 088357f147729462082e582be1db43d6 ""
+  "calzone.toc" 1728068469 5158 f53adb573b8b63b9d6f6abf5dac11d8e "pdflatex"
   "mytable.png" 1727877915 716184 0235eb86d9c3d9d8be3cd26a9ca00db9 ""
   "nbsphinx.sty" 1723612157 8202 a429e7504022e861d9f81e9a64e9928d ""
-  "notebooks_ece_mce_12_1.png" 1728065756 55390 1a16cfda687f702d53b1653f869e18ca ""
-  "notebooks_hl_test_13_1.png" 1728065756 21799 b95978db8e70a26596193ce74b909cd8 ""
-  "notebooks_hl_test_14_1.png" 1728065756 21843 d147f5f8c65154f77466ca9f2e92235a ""
-  "notebooks_ici_8_1.png" 1728065757 43328 2354d7edb62b8a1f369fcba69d425870 ""
-  "notebooks_quickstart_16_1.png" 1728065757 39928 4117abd19af3b57bc8e66a51a57c56f8 ""
-  "notebooks_quickstart_18_1.png" 1728065757 42921 ee3df6891a29f399f164d5e55f05e6ec ""
-  "notebooks_quickstart_20_1.png" 1728065757 42127 7de1ea85f325862a865034006d735614 ""
-  "notebooks_quickstart_20_3.png" 1728065757 42854 005a6f616efd03d978c3cb107a73a066 ""
-  "notebooks_quickstart_20_5.png" 1728065757 44619 432e67878b412c5e06e1dcc821ed903c ""
-  "notebooks_reliability_diagram_3_0.png" 1728065758 40555 7f21493f44d7ea51f3eb7d2e560d4f0b ""
-  "notebooks_reliability_diagram_5_0.png" 1728065758 47576 38437d3c4064586dc155be2ef6c8735b ""
-  "notebooks_reliability_diagram_8_0.png" 1728065758 40689 0cb4ca8d3c4b37c78e0a871a292c915f ""
-  "notebooks_reliability_diagram_9_0.png" 1728065758 60864 f866db6032833e6af5b14aa39a869dde ""
-  "notebooks_spiegelhalter_z_9_1.png" 1728065758 22199 c90489bd51b52e777b195f116cce338b ""
+  "notebooks_ece_mce_12_1.png" 1728068461 55390 1a16cfda687f702d53b1653f869e18ca ""
+  "notebooks_hl_test_13_1.png" 1728068461 21799 b95978db8e70a26596193ce74b909cd8 ""
+  "notebooks_hl_test_14_1.png" 1728068461 21843 d147f5f8c65154f77466ca9f2e92235a ""
+  "notebooks_ici_8_1.png" 1728068462 43328 2354d7edb62b8a1f369fcba69d425870 ""
+  "notebooks_quickstart_16_1.png" 1728068462 39928 4117abd19af3b57bc8e66a51a57c56f8 ""
+  "notebooks_quickstart_18_1.png" 1728068462 42921 ee3df6891a29f399f164d5e55f05e6ec ""
+  "notebooks_quickstart_20_1.png" 1728068462 42127 7de1ea85f325862a865034006d735614 ""
+  "notebooks_quickstart_20_3.png" 1728068462 42854 005a6f616efd03d978c3cb107a73a066 ""
+  "notebooks_quickstart_20_5.png" 1728068462 44619 432e67878b412c5e06e1dcc821ed903c ""
+  "notebooks_reliability_diagram_3_0.png" 1728068462 40555 7f21493f44d7ea51f3eb7d2e560d4f0b ""
+  "notebooks_reliability_diagram_5_0.png" 1728068462 47576 38437d3c4064586dc155be2ef6c8735b ""
+  "notebooks_reliability_diagram_8_0.png" 1728068462 40689 0cb4ca8d3c4b37c78e0a871a292c915f ""
+  "notebooks_reliability_diagram_9_0.png" 1728068462 60864 f866db6032833e6af5b14aa39a869dde ""
+  "notebooks_spiegelhalter_z_9_1.png" 1728068463 22199 c90489bd51b52e777b195f116cce338b ""
   "sphinx.sty" 1727458774 50659 6d393be3f369a7862f0b19a359f1ab89 ""
-  "sphinxhighlight.sty" 1728065758 7553 83fb52292c17957d9f4aadcb28c57a87 ""
+  "sphinxhighlight.sty" 1728068463 7553 83fb52292c17957d9f4aadcb28c57a87 ""
   "sphinxlatexadmonitions.sty" 1727458774 18222 f3bfd316b630ed188fcc20bf320acafe ""
   "sphinxlatexcontainers.sty" 1727458774 901 d3a3a1b7b2547f47ade2499350b5c420 ""
   "sphinxlatexgraphics.sty" 1727458774 4840 a9578332b6f3b35e198751fb632c9b79 ""
@@ -211,15 +211,15 @@
   "sphinxlatexstyletext.sty" 1727458774 6881 543f3cecccc7dccac396b5720cccf443 ""
   "sphinxlatextables.sty" 1727458774 57644 2253ce149b29042948a000d2dbf50b50 ""
   "sphinxmanual.cls" 1727458774 4241 7b0d7a37df7b5715fb0dbd585c52ecdb ""
-  "sphinxmessages.sty" 1728065759 745 3f5fcd6cdd7964ed608767954a8ced6f ""
+  "sphinxmessages.sty" 1728068464 745 3f5fcd6cdd7964ed608767954a8ced6f ""
   "sphinxoptionsgeometry.sty" 1727458774 2061 47bb34b8ed8a78823eb0c886abfb9f4d ""
   "sphinxoptionshyperref.sty" 1727458774 1094 79beb8b8a3f10784f8cce804e0f9d3aa ""
   "sphinxpackageboxes.sty" 1727458774 36106 1be2053eb1cb9b083b3a75e3657bcb24 ""
   "sphinxpackagefootnote.sty" 1727458774 15330 2fb656b6ce8cd1f6aba2d1c508fb51e5 ""
   (generated)
-  "calzone.log"
-  "calzone.idx"
-  "calzone.pdf"
+  "calzone.out"
   "calzone.aux"
+  "calzone.log"
   "calzone.toc"
-  "calzone.out"
+  "calzone.pdf"
+  "calzone.idx"
diff --git a/docs/build/latex/calzone.log b/docs/build/latex/calzone.log
@@ -1,4 +1,4 @@
-This is pdfTeX, Version 3.14159265-2.6-1.40.20 (TeX Live 2019/Debian) (preloaded format=pdflatex 2024.10.4)  4 OCT 2024 14:00
+This is pdfTeX, Version 3.14159265-2.6-1.40.20 (TeX Live 2019/Debian) (preloaded format=pdflatex 2024.10.4)  4 OCT 2024 14:45
 entering extended mode
  restricted \write18 enabled.
  %&-line parsing enabled.

diff --git a/docs/build/latex/calzone.pdf b/docs/build/latex/calzone.pdf
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -11,7 +11,7 @@
 sys.path.insert(0, os.path.abspath('../../calzone'))
 
 project = 'calzone'
-copyright = '2024, Kwok Lung "Jason" Fan'
+copyright = 'No copyright'
 author = 'Kwok Lung "Jason" Fan, Qian Cao'
 release = 'develop'
 

diff --git a/paper/paper.md b/paper/paper.md
@@ -182,7 +182,7 @@ z, p_value = spiegelhalter_z_test(
 
 
 ### Metrics class
-`calzone` also provides a class `CalibrationMetrics` to calculate all the metrics mentioned above. The user can also use the class to calculate the metrics.
+`calzone` also provides a class called `CalibrationMetrics()` to calculate all the metrics mentioned above. The user can also use this class to calculate the metrics.
 
 ```python
 from calzone.metrics import CalibrationMetrics
@@ -227,6 +227,7 @@ where $\eta$ is the prevalence of the testing data, $\eta'$ is the prevalence of
 `calzone` also provides a command line interface to calculate the metrics. The user can visualize the calibration curve, calculate the metrics and their confidence intervals using the command line interface. To use the command line interface, the user can run `python cal_metrics.py -h` to see the help message.
 
 # Acknowledgements
+The authors acknowledge the Research Participation Program at the Center for Devices and Radiological Health administered by the Oak Ridge Institute for Science and Education through an interagency agreement between the U.S. Department of Energy and the U.S. Food and Drug Administration (FDA). 
 
 # Conflicts of interest
 The authors declare no conflicts of interest.