diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000000000000000000000000000000000000..d4bb2cbb9eddb1bb1b4f366623044af8e4830919
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = .
+BUILDDIR = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
new file mode 100644
index 0000000000000000000000000000000000000000..e2d1c88827ee4387e1ffaa874d7af86d9728dead
Binary files /dev/null and b/docs/_build/doctrees/environment.pickle differ
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..15587ca854ef885240995ed0662c2b60c3365c25
Binary files /dev/null and b/docs/_build/doctrees/index.doctree differ
diff --git a/docs/_build/doctrees/source/modules.doctree b/docs/_build/doctrees/source/modules.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..d79d74219bf868d555dfac7546cc4cd20ddb8ac2
Binary files /dev/null and b/docs/_build/doctrees/source/modules.doctree differ
diff --git a/docs/_build/doctrees/source/src.doctree b/docs/_build/doctrees/source/src.doctree
new file mode 100644
index 0000000000000000000000000000000000000000..df7b3c3b191849c2740b3c13047b24593df37666
Binary files /dev/null and b/docs/_build/doctrees/source/src.doctree differ
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
new file mode 100644
index 0000000000000000000000000000000000000000..d0332497fc1c277cc64a97da34d447262a1e71fe
--- /dev/null
+++ b/docs/_build/html/.buildinfo
@@ -0,0 +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: 3bd87c5970a2b25d4590719e2d2fd180
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..5200b2a8daf733a7099445e62983b785da126a3d
--- /dev/null
+++ b/docs/_build/html/_sources/index.rst.txt
@@ -0,0 +1,20 @@
+.. asdsd documentation master file, created by
+ sphinx-quickstart on Fri Jul 14 02:13:49 2023.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to asdsd's documentation!
+=================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_build/html/_sources/source/modules.rst.txt b/docs/_build/html/_sources/source/modules.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..e9ff8ac1a89c7bd18e69d633121f5a4022ac6fdf
--- /dev/null
+++ b/docs/_build/html/_sources/source/modules.rst.txt
@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+ :maxdepth: 4
+
+ src
diff --git a/docs/_build/html/_sources/source/src.rst.txt b/docs/_build/html/_sources/source/src.rst.txt
new file mode 100644
index 0000000000000000000000000000000000000000..ba434d4ee44df3e898ed893fcd082ec4d4bf039b
--- /dev/null
+++ b/docs/_build/html/_sources/source/src.rst.txt
@@ -0,0 +1,45 @@
+src package
+===========
+
+Submodules
+----------
+
+src.Dataset module
+------------------
+
+.. automodule:: src.Dataset
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.Plotter module
+------------------
+
+.. automodule:: src.Plotter
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.test\_dataset module
+------------------------
+
+.. automodule:: src.test_dataset
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.test\_plotter module
+------------------------
+
+.. automodule:: src.test_plotter
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: src
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/_build/html/_static/alabaster.css b/docs/_build/html/_static/alabaster.css
new file mode 100644
index 0000000000000000000000000000000000000000..517d0b29cb1193b1211c8853b58c65cddd1fa4d2
--- /dev/null
+++ b/docs/_build/html/_static/alabaster.css
@@ -0,0 +1,703 @@
+@import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: Georgia, serif;
+ font-size: 17px;
+ background-color: #fff;
+ color: #000;
+ margin: 0;
+ padding: 0;
+}
+
+
+div.document {
+ width: 940px;
+ margin: 30px auto 0 auto;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 220px;
+}
+
+div.sphinxsidebar {
+ width: 220px;
+ font-size: 14px;
+ line-height: 1.5;
+}
+
+hr {
+ border: 1px solid #B1B4B6;
+}
+
+div.body {
+ background-color: #fff;
+ color: #3E4349;
+ padding: 0 30px 0 30px;
+}
+
+div.body > .section {
+ text-align: left;
+}
+
+div.footer {
+ width: 940px;
+ margin: 20px auto 30px auto;
+ font-size: 14px;
+ color: #888;
+ text-align: right;
+}
+
+div.footer a {
+ color: #888;
+}
+
+p.caption {
+ font-family: inherit;
+ font-size: inherit;
+}
+
+
+div.relations {
+ display: none;
+}
+
+
+div.sphinxsidebar a {
+ color: #444;
+ text-decoration: none;
+ border-bottom: 1px dotted #999;
+}
+
+div.sphinxsidebar a:hover {
+ border-bottom: 1px solid #999;
+}
+
+div.sphinxsidebarwrapper {
+ padding: 18px 10px;
+}
+
+div.sphinxsidebarwrapper p.logo {
+ padding: 0;
+ margin: -10px 0 0 0px;
+ text-align: center;
+}
+
+div.sphinxsidebarwrapper h1.logo {
+ margin-top: -10px;
+ text-align: center;
+ margin-bottom: 5px;
+ text-align: left;
+}
+
+div.sphinxsidebarwrapper h1.logo-name {
+ margin-top: 0px;
+}
+
+div.sphinxsidebarwrapper p.blurb {
+ margin-top: 0;
+ font-style: normal;
+}
+
+div.sphinxsidebar h3,
+div.sphinxsidebar h4 {
+ font-family: Georgia, serif;
+ color: #444;
+ font-size: 24px;
+ font-weight: normal;
+ margin: 0 0 5px 0;
+ padding: 0;
+}
+
+div.sphinxsidebar h4 {
+ font-size: 20px;
+}
+
+div.sphinxsidebar h3 a {
+ color: #444;
+}
+
+div.sphinxsidebar p.logo a,
+div.sphinxsidebar h3 a,
+div.sphinxsidebar p.logo a:hover,
+div.sphinxsidebar h3 a:hover {
+ border: none;
+}
+
+div.sphinxsidebar p {
+ color: #555;
+ margin: 10px 0;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px 0;
+ padding: 0;
+ color: #000;
+}
+
+div.sphinxsidebar ul li.toctree-l1 > a {
+ font-size: 120%;
+}
+
+div.sphinxsidebar ul li.toctree-l2 > a {
+ font-size: 110%;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #CCC;
+ font-family: Georgia, serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar hr {
+ border: none;
+ height: 1px;
+ color: #AAA;
+ background: #AAA;
+
+ text-align: left;
+ margin-left: 0;
+ width: 50%;
+}
+
+div.sphinxsidebar .badge {
+ border-bottom: none;
+}
+
+div.sphinxsidebar .badge:hover {
+ border-bottom: none;
+}
+
+/* To address an issue with donation coming after search */
+div.sphinxsidebar h3.donation {
+ margin-top: 10px;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+ color: #004B6B;
+ text-decoration: underline;
+}
+
+a:hover {
+ color: #6D4100;
+ text-decoration: underline;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: Georgia, serif;
+ font-weight: normal;
+ margin: 30px 0px 10px 0px;
+ padding: 0;
+}
+
+div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
+div.body h2 { font-size: 180%; }
+div.body h3 { font-size: 150%; }
+div.body h4 { font-size: 130%; }
+div.body h5 { font-size: 100%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: #DDD;
+ padding: 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ color: #444;
+ background: #EAEAEA;
+}
+
+div.body p, div.body dd, div.body li {
+ line-height: 1.4em;
+}
+
+div.admonition {
+ margin: 20px 0px;
+ padding: 10px 30px;
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
+ background-color: #FBFBFB;
+ border-bottom: 1px solid #fafafa;
+}
+
+div.admonition p.admonition-title {
+ font-family: Georgia, serif;
+ font-weight: normal;
+ font-size: 24px;
+ margin: 0 0 10px 0;
+ padding: 0;
+ line-height: 1;
+}
+
+div.admonition p.last {
+ margin-bottom: 0;
+}
+
+div.highlight {
+ background-color: #fff;
+}
+
+dt:target, .highlight {
+ background: #FAF3E8;
+}
+
+div.warning {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.danger {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+ -moz-box-shadow: 2px 2px 4px #D52C2C;
+ -webkit-box-shadow: 2px 2px 4px #D52C2C;
+ box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.error {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+ -moz-box-shadow: 2px 2px 4px #D52C2C;
+ -webkit-box-shadow: 2px 2px 4px #D52C2C;
+ box-shadow: 2px 2px 4px #D52C2C;
+}
+
+div.caution {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.attention {
+ background-color: #FCC;
+ border: 1px solid #FAA;
+}
+
+div.important {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.note {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.tip {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.hint {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.seealso {
+ background-color: #EEE;
+ border: 1px solid #CCC;
+}
+
+div.topic {
+ background-color: #EEE;
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre, tt, code {
+ font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+ font-size: 0.9em;
+}
+
+.hll {
+ background-color: #FFC;
+ margin: 0 -12px;
+ padding: 0 12px;
+ display: block;
+}
+
+img.screenshot {
+}
+
+tt.descname, tt.descclassname, code.descname, code.descclassname {
+ font-size: 0.95em;
+}
+
+tt.descname, code.descname {
+ padding-right: 0.08em;
+}
+
+img.screenshot {
+ -moz-box-shadow: 2px 2px 4px #EEE;
+ -webkit-box-shadow: 2px 2px 4px #EEE;
+ box-shadow: 2px 2px 4px #EEE;
+}
+
+table.docutils {
+ border: 1px solid #888;
+ -moz-box-shadow: 2px 2px 4px #EEE;
+ -webkit-box-shadow: 2px 2px 4px #EEE;
+ box-shadow: 2px 2px 4px #EEE;
+}
+
+table.docutils td, table.docutils th {
+ border: 1px solid #888;
+ padding: 0.25em 0.7em;
+}
+
+table.field-list, table.footnote {
+ border: none;
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+
+table.footnote {
+ margin: 15px 0;
+ width: 100%;
+ border: 1px solid #EEE;
+ background: #FDFDFD;
+ font-size: 0.9em;
+}
+
+table.footnote + table.footnote {
+ margin-top: -15px;
+ border-top: none;
+}
+
+table.field-list th {
+ padding: 0 0.8em 0 0;
+}
+
+table.field-list td {
+ padding: 0;
+}
+
+table.field-list p {
+ margin-bottom: 0.8em;
+}
+
+/* Cloned from
+ * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
+ */
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+table.footnote td.label {
+ width: .1px;
+ padding: 0.3em 0 0.3em 0.5em;
+}
+
+table.footnote td {
+ padding: 0.3em 0.5em;
+}
+
+dl {
+ margin-left: 0;
+ margin-right: 0;
+ margin-top: 0;
+ padding: 0;
+}
+
+dl dd {
+ margin-left: 30px;
+}
+
+blockquote {
+ margin: 0 0 0 30px;
+ padding: 0;
+}
+
+ul, ol {
+ /* Matches the 30px from the narrow-screen "li > ul" selector below */
+ margin: 10px 0 10px 30px;
+ padding: 0;
+}
+
+pre {
+ background: #EEE;
+ padding: 7px 30px;
+ margin: 15px 0px;
+ line-height: 1.3em;
+}
+
+div.viewcode-block:target {
+ background: #ffd;
+}
+
+dl pre, blockquote pre, li pre {
+ margin-left: 0;
+ padding-left: 30px;
+}
+
+tt, code {
+ background-color: #ecf0f3;
+ color: #222;
+ /* padding: 1px 2px; */
+}
+
+tt.xref, code.xref, a tt {
+ background-color: #FBFBFB;
+ border-bottom: 1px solid #fff;
+}
+
+a.reference {
+ text-decoration: none;
+ border-bottom: 1px dotted #004B6B;
+}
+
+/* Don't put an underline on images */
+a.image-reference, a.image-reference:hover {
+ border-bottom: none;
+}
+
+a.reference:hover {
+ border-bottom: 1px solid #6D4100;
+}
+
+a.footnote-reference {
+ text-decoration: none;
+ font-size: 0.7em;
+ vertical-align: top;
+ border-bottom: 1px dotted #004B6B;
+}
+
+a.footnote-reference:hover {
+ border-bottom: 1px solid #6D4100;
+}
+
+a:hover tt, a:hover code {
+ background: #EEE;
+}
+
+
+@media screen and (max-width: 870px) {
+
+ div.sphinxsidebar {
+ display: none;
+ }
+
+ div.document {
+ width: 100%;
+
+ }
+
+ div.documentwrapper {
+ margin-left: 0;
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
+ }
+
+ div.bodywrapper {
+ margin-top: 0;
+ margin-right: 0;
+ margin-bottom: 0;
+ margin-left: 0;
+ }
+
+ ul {
+ margin-left: 0;
+ }
+
+ li > ul {
+ /* Matches the 30px from the "ul, ol" selector above */
+ margin-left: 30px;
+ }
+
+ .document {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .bodywrapper {
+ margin: 0;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .github {
+ display: none;
+ }
+
+
+
+}
+
+
+
+@media screen and (max-width: 875px) {
+
+ body {
+ margin: 0;
+ padding: 20px 30px;
+ }
+
+ div.documentwrapper {
+ float: none;
+ background: #fff;
+ }
+
+ div.sphinxsidebar {
+ display: block;
+ float: none;
+ width: 102.5%;
+ margin: 50px -30px -20px -30px;
+ padding: 10px 20px;
+ background: #333;
+ color: #FFF;
+ }
+
+ div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
+ div.sphinxsidebar h3 a {
+ color: #fff;
+ }
+
+ div.sphinxsidebar a {
+ color: #AAA;
+ }
+
+ div.sphinxsidebar p.logo {
+ display: none;
+ }
+
+ div.document {
+ width: 100%;
+ margin: 0;
+ }
+
+ div.footer {
+ display: none;
+ }
+
+ div.bodywrapper {
+ margin: 0;
+ }
+
+ div.body {
+ min-height: 0;
+ padding: 0;
+ }
+
+ .rtd_doc_footer {
+ display: none;
+ }
+
+ .document {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .footer {
+ width: auto;
+ }
+
+ .github {
+ display: none;
+ }
+}
+
+
+/* misc. */
+
+.revsys-inline {
+ display: none!important;
+}
+
+/* Make nested-list/multi-paragraph items look better in Releases changelog
+ * pages. Without this, docutils' magical list fuckery causes inconsistent
+ * formatting between different release sub-lists.
+ */
+div#changelog > div.section > ul > li > p:only-child {
+ margin-bottom: 0;
+}
+
+/* Hide fugly table cell borders in ..bibliography:: directive output */
+table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
+ border: none;
+ /* Below needed in some edge cases; if not applied, bottom shadows appear */
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+
+
+/* relbar */
+
+.related {
+ line-height: 30px;
+ width: 100%;
+ font-size: 0.9rem;
+}
+
+.related.top {
+ border-bottom: 1px solid #EEE;
+ margin-bottom: 20px;
+}
+
+.related.bottom {
+ border-top: 1px solid #EEE;
+}
+
+.related ul {
+ padding: 0;
+ margin: 0;
+ list-style: none;
+}
+
+.related li {
+ display: inline;
+}
+
+nav#rellinks {
+ float: right;
+}
+
+nav#rellinks li+li:before {
+ content: "|";
+}
+
+nav#breadcrumbs li+li:before {
+ content: "\00BB";
+}
+
+/* Hide certain items when printing */
+@media print {
+ div.related {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css
new file mode 100644
index 0000000000000000000000000000000000000000..7577acb1ad176e3f58c15ddf9bf1f73525dfe7ed
--- /dev/null
+++ b/docs/_build/html/_static/basic.css
@@ -0,0 +1,903 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+ clear: both;
+}
+
+div.section::after {
+ display: block;
+ content: '';
+ clear: left;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+ width: 100%;
+ font-size: 90%;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ margin: 0;
+ padding: 0 0 0 10px;
+ list-style: none;
+}
+
+div.related li {
+ display: inline;
+}
+
+div.related li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+ padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+ float: left;
+ width: 230px;
+ margin-left: -100%;
+ font-size: 90%;
+ word-wrap: break-word;
+ overflow-wrap : break-word;
+}
+
+div.sphinxsidebar ul {
+ list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+ margin-left: 20px;
+ list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+ margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox form.search {
+ overflow: hidden;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+ float: left;
+ width: 80%;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+ float: left;
+ width: 20%;
+ border-left: none;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+
+img {
+ border: 0;
+ max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li p.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+ width: 90%;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+ width: 100%;
+}
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable ul {
+ margin-top: 0;
+ margin-bottom: 0;
+ list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+ padding-left: 0em;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+div.modindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+ padding: 2px;
+ border-collapse: collapse;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+div.body {
+ min-width: 360px;
+ max-width: 800px;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: auto;
+ -ms-hyphens: auto;
+ -webkit-hyphens: auto;
+ hyphens: auto;
+}
+
+a.headerlink {
+ visibility: hidden;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+ visibility: visible;
+}
+
+div.body p.caption {
+ text-align: inherit;
+}
+
+div.body td {
+ text-align: left;
+}
+
+.first {
+ margin-top: 0 !important;
+}
+
+p.rubric {
+ margin-top: 30px;
+ font-weight: bold;
+}
+
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
+ clear: left;
+ float: left;
+ margin-right: 1em;
+}
+
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
+ clear: right;
+ float: right;
+ margin-left: 1em;
+}
+
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+img.align-default, figure.align-default, .figure.align-default {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left;
+}
+
+.align-center {
+ text-align: center;
+}
+
+.align-default {
+ text-align: center;
+}
+
+.align-right {
+ text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar,
+aside.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+ clear: right;
+ overflow-x: auto;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+
+nav.contents,
+aside.topic,
+div.admonition, div.topic, blockquote {
+ clear: left;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+nav.contents,
+aside.topic,
+div.topic {
+ border: 1px solid #ccc;
+ padding: 7px;
+ margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding: 7px;
+}
+
+div.admonition dt {
+ font-weight: bold;
+}
+
+p.admonition-title {
+ margin: 0px 10px 5px 0px;
+ font-weight: bold;
+}
+
+div.body p.centered {
+ text-align: center;
+ margin-top: 25px;
+}
+
+/* -- content of sidebars/topics/admonitions -------------------------------- */
+
+div.sidebar > :last-child,
+aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
+div.topic > :last-child,
+div.admonition > :last-child {
+ margin-bottom: 0;
+}
+
+div.sidebar::after,
+aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
+div.topic::after,
+div.admonition::after,
+blockquote::after {
+ display: block;
+ content: '';
+ clear: both;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ border: 0;
+ border-collapse: collapse;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-default {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table caption span.caption-number {
+ font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 5px;
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+}
+
+th {
+ text-align: left;
+ padding-right: 5px;
+}
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px;
+}
+
+table.citation td {
+ border-bottom: none;
+}
+
+th > :first-child,
+td > :first-child {
+ margin-top: 0px;
+}
+
+th > :last-child,
+td > :last-child {
+ margin-bottom: 0px;
+}
+
+/* -- figures --------------------------------------------------------------- */
+
+div.figure, figure {
+ margin: 0.5em;
+ padding: 0.5em;
+}
+
+div.figure p.caption, figcaption {
+ padding: 0.3em;
+}
+
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
+ font-style: italic;
+}
+
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
+}
+
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist {
+ margin: 1em 0;
+}
+
+table.hlist td {
+ vertical-align: top;
+}
+
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+ font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+.sig-name {
+ font-size: 1.1em;
+}
+
+code.descname {
+ font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+ background-color: transparent;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.sig-paren {
+ font-size: larger;
+}
+
+.sig-param.n {
+ font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+ font-family: unset;
+}
+
+.sig.c .k, .sig.c .kt,
+.sig.cpp .k, .sig.cpp .kt {
+ color: #0033B3;
+}
+
+.sig.c .m,
+.sig.cpp .m {
+ color: #1750EB;
+}
+
+.sig.c .s, .sig.c .sc,
+.sig.cpp .s, .sig.cpp .sc {
+ color: #067D17;
+}
+
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+ list-style: decimal;
+}
+
+ol.loweralpha {
+ list-style: lower-alpha;
+}
+
+ol.upperalpha {
+ list-style: upper-alpha;
+}
+
+ol.lowerroman {
+ list-style: lower-roman;
+}
+
+ol.upperroman {
+ list-style: upper-roman;
+}
+
+:not(li) > ol > li:first-child > :first-child,
+:not(li) > ul > li:first-child > :first-child {
+ margin-top: 0px;
+}
+
+:not(li) > ol > li:last-child > :last-child,
+:not(li) > ul > li:last-child > :last-child {
+ margin-bottom: 0px;
+}
+
+ol.simple ol p,
+ol.simple ul p,
+ul.simple ol p,
+ul.simple ul p {
+ margin-top: 0;
+}
+
+ol.simple > li:not(:first-child) > p,
+ul.simple > li:not(:first-child) > p {
+ margin-top: 0;
+}
+
+ol.simple p,
+ul.simple p {
+ margin-bottom: 0;
+}
+
+aside.footnote > span,
+div.citation > span {
+ float: left;
+}
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+ padding-right: 0.5em;
+}
+aside.footnote > p {
+ margin-left: 2em;
+}
+div.citation > p {
+ margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
+ margin-bottom: 0em;
+}
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
+ content: "";
+ clear: both;
+}
+
+dl.field-list {
+ display: grid;
+ grid-template-columns: fit-content(30%) auto;
+}
+
+dl.field-list > dt {
+ font-weight: bold;
+ word-break: break-word;
+ padding-left: 0.5em;
+ padding-right: 5px;
+}
+
+dl.field-list > dd {
+ padding-left: 0.5em;
+ margin-top: 0em;
+ margin-left: 0em;
+ margin-bottom: 0em;
+}
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd > :first-child {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+dl > dd:last-child,
+dl > dd:last-child > :last-child {
+ margin-bottom: 0;
+}
+
+dt:target, span.highlighted {
+ background-color: #fbe54e;
+}
+
+rect.highlighted {
+ fill: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+.versionmodified {
+ font-style: italic;
+}
+
+.system-message {
+ background-color: #fda;
+ padding: 5px;
+ border: 3px solid red;
+}
+
+.footnote:target {
+ background-color: #ffa;
+}
+
+.line-block {
+ display: block;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+.line-block .line-block {
+ margin-top: 0;
+ margin-bottom: 0;
+ margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+ font-family: sans-serif;
+}
+
+.accelerator {
+ text-decoration: underline;
+}
+
+.classifier {
+ font-style: oblique;
+}
+
+.classifier:before {
+ font-style: normal;
+ margin: 0 0.5em;
+ content: ":";
+ display: inline-block;
+}
+
+abbr, acronym {
+ border-bottom: dotted 1px;
+ cursor: help;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+ overflow: auto;
+ overflow-y: hidden; /* fixes display issues on Chrome browsers */
+}
+
+pre, div[class*="highlight-"] {
+ clear: both;
+}
+
+span.pre {
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ -webkit-hyphens: none;
+ hyphens: none;
+ white-space: nowrap;
+}
+
+div[class*="highlight-"] {
+ margin: 1em 0;
+}
+
+td.linenos pre {
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ display: block;
+}
+
+table.highlighttable tbody {
+ display: block;
+}
+
+table.highlighttable tr {
+ display: flex;
+}
+
+table.highlighttable td {
+ margin: 0;
+ padding: 0;
+}
+
+table.highlighttable td.linenos {
+ padding-right: 0.5em;
+}
+
+table.highlighttable td.code {
+ flex: 1;
+ overflow: hidden;
+}
+
+.highlight .hll {
+ display: block;
+}
+
+div.highlight pre,
+table.highlighttable pre {
+ margin: 0;
+}
+
+div.code-block-caption + div {
+ margin-top: 0;
+}
+
+div.code-block-caption {
+ margin-top: 1em;
+ padding: 2px 5px;
+ font-size: small;
+}
+
+div.code-block-caption code {
+ background-color: transparent;
+}
+
+table.highlighttable td.linenos,
+span.linenos,
+div.highlight span.gp { /* gp: Generic.Prompt */
+ user-select: none;
+ -webkit-user-select: text; /* Safari fallback only */
+ -webkit-user-select: none; /* Chrome/Safari */
+ -moz-user-select: none; /* Firefox */
+ -ms-user-select: none; /* IE10+ */
+}
+
+div.code-block-caption span.caption-number {
+ padding: 0.1em 0.3em;
+ font-style: italic;
+}
+
+div.code-block-caption span.caption-text {
+}
+
+div.literal-block-wrapper {
+ margin: 1em 0;
+}
+
+code.xref, a code {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ background-color: transparent;
+}
+
+.viewcode-link {
+ float: right;
+}
+
+.viewcode-back {
+ float: right;
+ font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+ margin: -1px -10px;
+ padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+ vertical-align: middle;
+}
+
+div.body div.math p {
+ text-align: center;
+}
+
+span.eqno {
+ float: right;
+}
+
+span.eqno a.headerlink {
+ position: absolute;
+ z-index: 1;
+}
+
+div.math:hover a.headerlink {
+ visibility: visible;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+ div.document,
+ div.documentwrapper,
+ div.bodywrapper {
+ margin: 0 !important;
+ width: 100%;
+ }
+
+ div.sphinxsidebar,
+ div.related,
+ div.footer,
+ #top-link {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/docs/_build/html/_static/custom.css b/docs/_build/html/_static/custom.css
new file mode 100644
index 0000000000000000000000000000000000000000..2a924f1d6a8bc930c5296bdb2d5c2d3e39b04a1c
--- /dev/null
+++ b/docs/_build/html/_static/custom.css
@@ -0,0 +1 @@
+/* This file intentionally left blank. */
diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/html/_static/doctools.js
new file mode 100644
index 0000000000000000000000000000000000000000..d06a71d7518041301a303697d2a3c372648eb7bf
--- /dev/null
+++ b/docs/_build/html/_static/doctools.js
@@ -0,0 +1,156 @@
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Base JavaScript utilities for all Sphinx HTML documentation.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
+ "TEXTAREA",
+ "INPUT",
+ "SELECT",
+ "BUTTON",
+]);
+
+const _ready = (callback) => {
+ if (document.readyState !== "loading") {
+ callback();
+ } else {
+ document.addEventListener("DOMContentLoaded", callback);
+ }
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const Documentation = {
+ init: () => {
+ Documentation.initDomainIndexTable();
+ Documentation.initOnKeyListeners();
+ },
+
+ /**
+ * i18n support
+ */
+ TRANSLATIONS: {},
+ PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
+ LOCALE: "unknown",
+
+ // gettext and ngettext don't access this so that the functions
+ // can safely bound to a different name (_ = Documentation.gettext)
+ gettext: (string) => {
+ const translated = Documentation.TRANSLATIONS[string];
+ switch (typeof translated) {
+ case "undefined":
+ return string; // no translation
+ case "string":
+ return translated; // translation exists
+ default:
+ return translated[0]; // (singular, plural) translation tuple exists
+ }
+ },
+
+ ngettext: (singular, plural, n) => {
+ const translated = Documentation.TRANSLATIONS[singular];
+ if (typeof translated !== "undefined")
+ return translated[Documentation.PLURAL_EXPR(n)];
+ return n === 1 ? singular : plural;
+ },
+
+ addTranslations: (catalog) => {
+ Object.assign(Documentation.TRANSLATIONS, catalog.messages);
+ Documentation.PLURAL_EXPR = new Function(
+ "n",
+ `return (${catalog.plural_expr})`
+ );
+ Documentation.LOCALE = catalog.locale;
+ },
+
+ /**
+ * helper function to focus on search bar
+ */
+ focusSearchBar: () => {
+ document.querySelectorAll("input[name=q]")[0]?.focus();
+ },
+
+ /**
+ * Initialise the domain index toggle buttons
+ */
+ initDomainIndexTable: () => {
+ const toggler = (el) => {
+ const idNumber = el.id.substr(7);
+ const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
+ if (el.src.substr(-9) === "minus.png") {
+ el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
+ toggledRows.forEach((el) => (el.style.display = "none"));
+ } else {
+ el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
+ toggledRows.forEach((el) => (el.style.display = ""));
+ }
+ };
+
+ const togglerElements = document.querySelectorAll("img.toggler");
+ togglerElements.forEach((el) =>
+ el.addEventListener("click", (event) => toggler(event.currentTarget))
+ );
+ togglerElements.forEach((el) => (el.style.display = ""));
+ if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
+ },
+
+ initOnKeyListeners: () => {
+ // only install a listener if it is really needed
+ if (
+ !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+ !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
+ )
+ return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.altKey || event.ctrlKey || event.metaKey) return;
+
+ if (!event.shiftKey) {
+ switch (event.key) {
+ case "ArrowLeft":
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+ const prevLink = document.querySelector('link[rel="prev"]');
+ if (prevLink && prevLink.href) {
+ window.location.href = prevLink.href;
+ event.preventDefault();
+ }
+ break;
+ case "ArrowRight":
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+ const nextLink = document.querySelector('link[rel="next"]');
+ if (nextLink && nextLink.href) {
+ window.location.href = nextLink.href;
+ event.preventDefault();
+ }
+ break;
+ }
+ }
+
+ // some keyboard layouts may need Shift to get /
+ switch (event.key) {
+ case "/":
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
+ Documentation.focusSearchBar();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+// quick alias for translations
+const _ = Documentation.gettext;
+
+_ready(Documentation.init);
diff --git a/docs/_build/html/_static/documentation_options.js b/docs/_build/html/_static/documentation_options.js
new file mode 100644
index 0000000000000000000000000000000000000000..cf359c0aad32f8805069701660a38636570be55a
--- /dev/null
+++ b/docs/_build/html/_static/documentation_options.js
@@ -0,0 +1,14 @@
+var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+ VERSION: '0.1',
+ LANGUAGE: 'en',
+ COLLAPSE_INDEX: false,
+ BUILDER: 'html',
+ FILE_SUFFIX: '.html',
+ LINK_SUFFIX: '.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt',
+ NAVIGATION_WITH_KEYS: false,
+ SHOW_SEARCH_SUMMARY: true,
+ ENABLE_SEARCH_SHORTCUTS: true,
+};
\ No newline at end of file
diff --git a/docs/_build/html/_static/file.png b/docs/_build/html/_static/file.png
new file mode 100644
index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3
Binary files /dev/null and b/docs/_build/html/_static/file.png differ
diff --git a/docs/_build/html/_static/language_data.js b/docs/_build/html/_static/language_data.js
new file mode 100644
index 0000000000000000000000000000000000000000..250f5665fa64b70c822190199b3b804b10f8b9d8
--- /dev/null
+++ b/docs/_build/html/_static/language_data.js
@@ -0,0 +1,199 @@
+/*
+ * language_data.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
+
+
+/* Non-minified version is copied as a separate JS file, is available */
+
+/**
+ * Porter Stemmer
+ */
+var Stemmer = function() {
+
+ var step2list = {
+ ational: 'ate',
+ tional: 'tion',
+ enci: 'ence',
+ anci: 'ance',
+ izer: 'ize',
+ bli: 'ble',
+ alli: 'al',
+ entli: 'ent',
+ eli: 'e',
+ ousli: 'ous',
+ ization: 'ize',
+ ation: 'ate',
+ ator: 'ate',
+ alism: 'al',
+ iveness: 'ive',
+ fulness: 'ful',
+ ousness: 'ous',
+ aliti: 'al',
+ iviti: 'ive',
+ biliti: 'ble',
+ logi: 'log'
+ };
+
+ var step3list = {
+ icate: 'ic',
+ ative: '',
+ alize: 'al',
+ iciti: 'ic',
+ ical: 'ic',
+ ful: '',
+ ness: ''
+ };
+
+ var c = "[^aeiou]"; // consonant
+ var v = "[aeiouy]"; // vowel
+ var C = c + "[^aeiouy]*"; // consonant sequence
+ var V = v + "[aeiou]*"; // vowel sequence
+
+ var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
+ var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
+ var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
+ var s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ this.stemWord = function (w) {
+ var stem;
+ var suffix;
+ var firstch;
+ var origword = w;
+
+ if (w.length < 3)
+ return w;
+
+ var re;
+ var re2;
+ var re3;
+ var re4;
+
+ firstch = w.substr(0,1);
+ if (firstch == "y")
+ w = firstch.toUpperCase() + w.substr(1);
+
+ // Step 1a
+ re = /^(.+?)(ss|i)es$/;
+ re2 = /^(.+?)([^s])s$/;
+
+ if (re.test(w))
+ w = w.replace(re,"$1$2");
+ else if (re2.test(w))
+ w = w.replace(re2,"$1$2");
+
+ // Step 1b
+ re = /^(.+?)eed$/;
+ re2 = /^(.+?)(ed|ing)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = new RegExp(mgr0);
+ if (re.test(fp[1])) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = new RegExp(s_v);
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = /(at|bl|iz)$/;
+ re3 = new RegExp("([^aeiouylsz])\\1$");
+ re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re2.test(w))
+ w = w + "e";
+ else if (re3.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+ else if (re4.test(w))
+ w = w + "e";
+ }
+ }
+
+ // Step 1c
+ re = /^(.+?)y$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(s_v);
+ if (re.test(stem))
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step2list[suffix];
+ }
+
+ // Step 3
+ re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = new RegExp(mgr0);
+ if (re.test(stem))
+ w = stem + step3list[suffix];
+ }
+
+ // Step 4
+ re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ re2 = /^(.+?)(s|t)(ion)$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ if (re.test(stem))
+ w = stem;
+ }
+ else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = new RegExp(mgr1);
+ if (re2.test(stem))
+ w = stem;
+ }
+
+ // Step 5
+ re = /^(.+?)e$/;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = new RegExp(mgr1);
+ re2 = new RegExp(meq1);
+ re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
+ w = stem;
+ }
+ re = /ll$/;
+ re2 = new RegExp(mgr1);
+ if (re.test(w) && re2.test(w)) {
+ re = /.$/;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+ if (firstch == "y")
+ w = firstch.toLowerCase() + w.substr(1);
+ return w;
+ }
+}
+
diff --git a/docs/_build/html/_static/minus.png b/docs/_build/html/_static/minus.png
new file mode 100644
index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d
Binary files /dev/null and b/docs/_build/html/_static/minus.png differ
diff --git a/docs/_build/html/_static/plus.png b/docs/_build/html/_static/plus.png
new file mode 100644
index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d
Binary files /dev/null and b/docs/_build/html/_static/plus.png differ
diff --git a/docs/_build/html/_static/pygments.css b/docs/_build/html/_static/pygments.css
new file mode 100644
index 0000000000000000000000000000000000000000..9abe04ba552e93102be60b10311b288fbc57ab51
--- /dev/null
+++ b/docs/_build/html/_static/pygments.css
@@ -0,0 +1,83 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+.highlight .hll { background-color: #ffffcc }
+.highlight { background: #f8f8f8; }
+.highlight .c { color: #8f5902; font-style: italic } /* Comment */
+.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
+.highlight .g { color: #000000 } /* Generic */
+.highlight .k { color: #004461; font-weight: bold } /* Keyword */
+.highlight .l { color: #000000 } /* Literal */
+.highlight .n { color: #000000 } /* Name */
+.highlight .o { color: #582800 } /* Operator */
+.highlight .x { color: #000000 } /* Other */
+.highlight .p { color: #000000; font-weight: bold } /* Punctuation */
+.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */
+.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #8f5902 } /* Comment.Preproc */
+.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */
+.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #a40000 } /* Generic.Deleted */
+.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #ef2929 } /* Generic.Error */
+.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
+.highlight .gi { color: #00A000 } /* Generic.Inserted */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #745334 } /* Generic.Prompt */
+.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
+.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */
+.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */
+.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */
+.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */
+.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */
+.highlight .ld { color: #000000 } /* Literal.Date */
+.highlight .m { color: #990000 } /* Literal.Number */
+.highlight .s { color: #4e9a06 } /* Literal.String */
+.highlight .na { color: #c4a000 } /* Name.Attribute */
+.highlight .nb { color: #004461 } /* Name.Builtin */
+.highlight .nc { color: #000000 } /* Name.Class */
+.highlight .no { color: #000000 } /* Name.Constant */
+.highlight .nd { color: #888888 } /* Name.Decorator */
+.highlight .ni { color: #ce5c00 } /* Name.Entity */
+.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #000000 } /* Name.Function */
+.highlight .nl { color: #f57900 } /* Name.Label */
+.highlight .nn { color: #000000 } /* Name.Namespace */
+.highlight .nx { color: #000000 } /* Name.Other */
+.highlight .py { color: #000000 } /* Name.Property */
+.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #000000 } /* Name.Variable */
+.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */
+.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */
+.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */
+.highlight .mb { color: #990000 } /* Literal.Number.Bin */
+.highlight .mf { color: #990000 } /* Literal.Number.Float */
+.highlight .mh { color: #990000 } /* Literal.Number.Hex */
+.highlight .mi { color: #990000 } /* Literal.Number.Integer */
+.highlight .mo { color: #990000 } /* Literal.Number.Oct */
+.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
+.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
+.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
+.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
+.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
+.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
+.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
+.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */
+.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */
+.highlight .sx { color: #4e9a06 } /* Literal.String.Other */
+.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */
+.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
+.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
+.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
+.highlight .fm { color: #000000 } /* Name.Function.Magic */
+.highlight .vc { color: #000000 } /* Name.Variable.Class */
+.highlight .vg { color: #000000 } /* Name.Variable.Global */
+.highlight .vi { color: #000000 } /* Name.Variable.Instance */
+.highlight .vm { color: #000000 } /* Name.Variable.Magic */
+.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/docs/_build/html/_static/searchtools.js b/docs/_build/html/_static/searchtools.js
new file mode 100644
index 0000000000000000000000000000000000000000..97d56a74d8207ec36a96a5e24f4a4b42dd51f6b2
--- /dev/null
+++ b/docs/_build/html/_static/searchtools.js
@@ -0,0 +1,566 @@
+/*
+ * searchtools.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for the full-text search.
+ *
+ * :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+/**
+ * Simple result scoring code.
+ */
+if (typeof Scorer === "undefined") {
+ var Scorer = {
+ // Implement the following function to further tweak the score for each result
+ // The function takes a result array [docname, title, anchor, descr, score, filename]
+ // and returns the new score.
+ /*
+ score: result => {
+ const [docname, title, anchor, descr, score, filename] = result
+ return score
+ },
+ */
+
+ // query matches the full name of an object
+ objNameMatch: 11,
+ // or matches in the last dotted part of the object name
+ objPartialMatch: 6,
+ // Additive scores depending on the priority of the object
+ objPrio: {
+ 0: 15, // used to be importantResults
+ 1: 5, // used to be objectResults
+ 2: -5, // used to be unimportantResults
+ },
+ // Used when the priority is not in the mapping.
+ objPrioDefault: 0,
+
+ // query found in title
+ title: 15,
+ partialTitle: 7,
+ // query found in terms
+ term: 5,
+ partialTerm: 2,
+ };
+}
+
+const _removeChildren = (element) => {
+ while (element && element.lastChild) element.removeChild(element.lastChild);
+};
+
+/**
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
+ */
+const _escapeRegExp = (string) =>
+ string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
+
+const _displayItem = (item, searchTerms) => {
+ const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+ const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
+ const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
+ const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+ const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+
+ const [docName, title, anchor, descr, score, _filename] = item;
+
+ let listItem = document.createElement("li");
+ let requestUrl;
+ let linkUrl;
+ if (docBuilder === "dirhtml") {
+ // dirhtml builder
+ let dirname = docName + "/";
+ if (dirname.match(/\/index\/$/))
+ dirname = dirname.substring(0, dirname.length - 6);
+ else if (dirname === "index/") dirname = "";
+ requestUrl = docUrlRoot + dirname;
+ linkUrl = requestUrl;
+ } else {
+ // normal html builders
+ requestUrl = docUrlRoot + docName + docFileSuffix;
+ linkUrl = docName + docLinkSuffix;
+ }
+ let linkEl = listItem.appendChild(document.createElement("a"));
+ linkEl.href = linkUrl + anchor;
+ linkEl.dataset.score = score;
+ linkEl.innerHTML = title;
+ if (descr)
+ listItem.appendChild(document.createElement("span")).innerHTML =
+ " (" + descr + ")";
+ else if (showSearchSummary)
+ fetch(requestUrl)
+ .then((responseData) => responseData.text())
+ .then((data) => {
+ if (data)
+ listItem.appendChild(
+ Search.makeSearchSummary(data, searchTerms)
+ );
+ });
+ Search.output.appendChild(listItem);
+};
+const _finishSearch = (resultCount) => {
+ Search.stopPulse();
+ Search.title.innerText = _("Search Results");
+ if (!resultCount)
+ Search.status.innerText = Documentation.gettext(
+ "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
+ );
+ else
+ Search.status.innerText = _(
+ `Search finished, found ${resultCount} page(s) matching the search query.`
+ );
+};
+const _displayNextItem = (
+ results,
+ resultCount,
+ searchTerms
+) => {
+ // results left, load the summary and display it
+ // this is intended to be dynamic (don't sub resultsCount)
+ if (results.length) {
+ _displayItem(results.pop(), searchTerms);
+ setTimeout(
+ () => _displayNextItem(results, resultCount, searchTerms),
+ 5
+ );
+ }
+ // search finished, update title and status message
+ else _finishSearch(resultCount);
+};
+
+/**
+ * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
+ * custom function per language.
+ *
+ * The regular expression works by splitting the string on consecutive characters
+ * that are not Unicode letters, numbers, underscores, or emoji characters.
+ * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
+ */
+if (typeof splitQuery === "undefined") {
+ var splitQuery = (query) => query
+ .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
+ .filter(term => term) // remove remaining empty strings
+}
+
+/**
+ * Search Module
+ */
+const Search = {
+ _index: null,
+ _queued_query: null,
+ _pulse_status: -1,
+
+ htmlToText: (htmlString) => {
+ const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
+ htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
+ const docContent = htmlElement.querySelector('[role="main"]');
+ if (docContent !== undefined) return docContent.textContent;
+ console.warn(
+ "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
+ );
+ return "";
+ },
+
+ init: () => {
+ const query = new URLSearchParams(window.location.search).get("q");
+ document
+ .querySelectorAll('input[name="q"]')
+ .forEach((el) => (el.value = query));
+ if (query) Search.performSearch(query);
+ },
+
+ loadIndex: (url) =>
+ (document.body.appendChild(document.createElement("script")).src = url),
+
+ setIndex: (index) => {
+ Search._index = index;
+ if (Search._queued_query !== null) {
+ const query = Search._queued_query;
+ Search._queued_query = null;
+ Search.query(query);
+ }
+ },
+
+ hasIndex: () => Search._index !== null,
+
+ deferQuery: (query) => (Search._queued_query = query),
+
+ stopPulse: () => (Search._pulse_status = -1),
+
+ startPulse: () => {
+ if (Search._pulse_status >= 0) return;
+
+ const pulse = () => {
+ Search._pulse_status = (Search._pulse_status + 1) % 4;
+ Search.dots.innerText = ".".repeat(Search._pulse_status);
+ if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
+ };
+ pulse();
+ },
+
+ /**
+ * perform a search for something (or wait until index is loaded)
+ */
+ performSearch: (query) => {
+ // create the required interface elements
+ const searchText = document.createElement("h2");
+ searchText.textContent = _("Searching");
+ const searchSummary = document.createElement("p");
+ searchSummary.classList.add("search-summary");
+ searchSummary.innerText = "";
+ const searchList = document.createElement("ul");
+ searchList.classList.add("search");
+
+ const out = document.getElementById("search-results");
+ Search.title = out.appendChild(searchText);
+ Search.dots = Search.title.appendChild(document.createElement("span"));
+ Search.status = out.appendChild(searchSummary);
+ Search.output = out.appendChild(searchList);
+
+ const searchProgress = document.getElementById("search-progress");
+ // Some themes don't use the search progress node
+ if (searchProgress) {
+ searchProgress.innerText = _("Preparing search...");
+ }
+ Search.startPulse();
+
+ // index already loaded, the browser was quick!
+ if (Search.hasIndex()) Search.query(query);
+ else Search.deferQuery(query);
+ },
+
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ query: (query) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+ const allTitles = Search._index.alltitles;
+ const indexEntries = Search._index.indexentries;
+
+ // stem the search terms and add them to the correct list
+ const stemmer = new Stemmer();
+ const searchTerms = new Set();
+ const excludedTerms = new Set();
+ const highlightTerms = new Set();
+ const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
+ splitQuery(query.trim()).forEach((queryTerm) => {
+ const queryTermLower = queryTerm.toLowerCase();
+
+ // maybe skip this "word"
+ // stopwords array is from language_data.js
+ if (
+ stopwords.indexOf(queryTermLower) !== -1 ||
+ queryTerm.match(/^\d+$/)
+ )
+ return;
+
+ // stem the word
+ let word = stemmer.stemWord(queryTermLower);
+ // select the correct list
+ if (word[0] === "-") excludedTerms.add(word.substr(1));
+ else {
+ searchTerms.add(word);
+ highlightTerms.add(queryTermLower);
+ }
+ });
+
+ if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
+ localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
+ }
+
+ // console.debug("SEARCH: searching for:");
+ // console.info("required: ", [...searchTerms]);
+ // console.info("excluded: ", [...excludedTerms]);
+
+ // array of [docname, title, anchor, descr, score, filename]
+ let results = [];
+ _removeChildren(document.getElementById("search-progress"));
+
+ const queryLower = query.toLowerCase();
+ for (const [title, foundTitles] of Object.entries(allTitles)) {
+ if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
+ for (const [file, id] of foundTitles) {
+ let score = Math.round(100 * queryLower.length / title.length)
+ results.push([
+ docNames[file],
+ titles[file] !== title ? `${titles[file]} > ${title}` : title,
+ id !== null ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ }
+ }
+
+ // search for explicit entries in index directives
+ for (const [entry, foundEntries] of Object.entries(indexEntries)) {
+ if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
+ for (const [file, id] of foundEntries) {
+ let score = Math.round(100 * queryLower.length / entry.length)
+ results.push([
+ docNames[file],
+ titles[file],
+ id ? "#" + id : "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ }
+ }
+
+ // lookup as object
+ objectTerms.forEach((term) =>
+ results.push(...Search.performObjectSearch(term, objectTerms))
+ );
+
+ // lookup as search terms in fulltext
+ results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+
+ // let the scorer override scores with a custom scoring function
+ if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
+
+ // now sort the results by score (in opposite order of appearance, since the
+ // display function below uses pop() to retrieve items) and then
+ // alphabetically
+ results.sort((a, b) => {
+ const leftScore = a[4];
+ const rightScore = b[4];
+ if (leftScore === rightScore) {
+ // same score: sort alphabetically
+ const leftTitle = a[1].toLowerCase();
+ const rightTitle = b[1].toLowerCase();
+ if (leftTitle === rightTitle) return 0;
+ return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+ }
+ return leftScore > rightScore ? 1 : -1;
+ });
+
+ // remove duplicate search results
+ // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
+ let seen = new Set();
+ results = results.reverse().reduce((acc, result) => {
+ let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
+ if (!seen.has(resultStr)) {
+ acc.push(result);
+ seen.add(resultStr);
+ }
+ return acc;
+ }, []);
+
+ results = results.reverse();
+
+ // for debugging
+ //Search.lastresults = results.slice(); // a copy
+ // console.info("search results:", Search.lastresults);
+
+ // print the results
+ _displayNextItem(results, results.length, searchTerms);
+ },
+
+ /**
+ * search for object names
+ */
+ performObjectSearch: (object, objectTerms) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const objects = Search._index.objects;
+ const objNames = Search._index.objnames;
+ const titles = Search._index.titles;
+
+ const results = [];
+
+ const objectSearchCallback = (prefix, match) => {
+ const name = match[4]
+ const fullname = (prefix ? prefix + "." : "") + name;
+ const fullnameLower = fullname.toLowerCase();
+ if (fullnameLower.indexOf(object) < 0) return;
+
+ let score = 0;
+ const parts = fullnameLower.split(".");
+
+ // check for different match types: exact matches of full name or
+ // "last name" (i.e. last dotted part)
+ if (fullnameLower === object || parts.slice(-1)[0] === object)
+ score += Scorer.objNameMatch;
+ else if (parts.slice(-1)[0].indexOf(object) > -1)
+ score += Scorer.objPartialMatch; // matches in last name
+
+ const objName = objNames[match[1]][2];
+ const title = titles[match[0]];
+
+ // If more than one term searched for, we require other words to be
+ // found in the name/title/description
+ const otherTerms = new Set(objectTerms);
+ otherTerms.delete(object);
+ if (otherTerms.size > 0) {
+ const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
+ if (
+ [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
+ )
+ return;
+ }
+
+ let anchor = match[3];
+ if (anchor === "") anchor = fullname;
+ else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
+
+ const descr = objName + _(", in ") + title;
+
+ // add custom score for some objects according to scorer
+ if (Scorer.objPrio.hasOwnProperty(match[2]))
+ score += Scorer.objPrio[match[2]];
+ else score += Scorer.objPrioDefault;
+
+ results.push([
+ docNames[match[0]],
+ fullname,
+ "#" + anchor,
+ descr,
+ score,
+ filenames[match[0]],
+ ]);
+ };
+ Object.keys(objects).forEach((prefix) =>
+ objects[prefix].forEach((array) =>
+ objectSearchCallback(prefix, array)
+ )
+ );
+ return results;
+ },
+
+ /**
+ * search for full-text terms in the index
+ */
+ performTermsSearch: (searchTerms, excludedTerms) => {
+ // prepare search
+ const terms = Search._index.terms;
+ const titleTerms = Search._index.titleterms;
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+
+ const scoreMap = new Map();
+ const fileMap = new Map();
+
+ // perform the search on the required terms
+ searchTerms.forEach((word) => {
+ const files = [];
+ const arr = [
+ { files: terms[word], score: Scorer.term },
+ { files: titleTerms[word], score: Scorer.title },
+ ];
+ // add support for partial matches
+ if (word.length > 2) {
+ const escapedWord = _escapeRegExp(word);
+ Object.keys(terms).forEach((term) => {
+ if (term.match(escapedWord) && !terms[word])
+ arr.push({ files: terms[term], score: Scorer.partialTerm });
+ });
+ Object.keys(titleTerms).forEach((term) => {
+ if (term.match(escapedWord) && !titleTerms[word])
+ arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
+ });
+ }
+
+ // no match but word was a required one
+ if (arr.every((record) => record.files === undefined)) return;
+
+ // found search word in contents
+ arr.forEach((record) => {
+ if (record.files === undefined) return;
+
+ let recordFiles = record.files;
+ if (recordFiles.length === undefined) recordFiles = [recordFiles];
+ files.push(...recordFiles);
+
+ // set score for the word in each file
+ recordFiles.forEach((file) => {
+ if (!scoreMap.has(file)) scoreMap.set(file, {});
+ scoreMap.get(file)[word] = record.score;
+ });
+ });
+
+ // create the mapping
+ files.forEach((file) => {
+ if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
+ fileMap.get(file).push(word);
+ else fileMap.set(file, [word]);
+ });
+ });
+
+ // now check if the files don't contain excluded terms
+ const results = [];
+ for (const [file, wordList] of fileMap) {
+ // check if all requirements are matched
+
+ // as search terms with length < 3 are discarded
+ const filteredTermCount = [...searchTerms].filter(
+ (term) => term.length > 2
+ ).length;
+ if (
+ wordList.length !== searchTerms.size &&
+ wordList.length !== filteredTermCount
+ )
+ continue;
+
+ // ensure that none of the excluded terms is in the search result
+ if (
+ [...excludedTerms].some(
+ (term) =>
+ terms[term] === file ||
+ titleTerms[term] === file ||
+ (terms[term] || []).includes(file) ||
+ (titleTerms[term] || []).includes(file)
+ )
+ )
+ break;
+
+ // select one (max) score for the file.
+ const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+ // add result to the result list
+ results.push([
+ docNames[file],
+ titles[file],
+ "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ return results;
+ },
+
+ /**
+ * helper function to return a node containing the
+ * search summary for a given text. keywords is a list
+ * of stemmed words.
+ */
+ makeSearchSummary: (htmlText, keywords) => {
+ const text = Search.htmlToText(htmlText);
+ if (text === "") return null;
+
+ const textLower = text.toLowerCase();
+ const actualStartPosition = [...keywords]
+ .map((k) => textLower.indexOf(k.toLowerCase()))
+ .filter((i) => i > -1)
+ .slice(-1)[0];
+ const startWithContext = Math.max(actualStartPosition - 120, 0);
+
+ const top = startWithContext === 0 ? "" : "...";
+ const tail = startWithContext + 240 < text.length ? "..." : "";
+
+ let summary = document.createElement("p");
+ summary.classList.add("context");
+ summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
+
+ return summary;
+ },
+};
+
+_ready(Search.init);
diff --git a/docs/_build/html/_static/sphinx_highlight.js b/docs/_build/html/_static/sphinx_highlight.js
new file mode 100644
index 0000000000000000000000000000000000000000..aae669d7ea6b1dc6edcb5c651f5d095f7a2dc6e6
--- /dev/null
+++ b/docs/_build/html/_static/sphinx_highlight.js
@@ -0,0 +1,144 @@
+/* Highlighting utilities for Sphinx HTML documentation. */
+"use strict";
+
+const SPHINX_HIGHLIGHT_ENABLED = true
+
+/**
+ * highlight a given string on a node by wrapping it in
+ * span elements with the given class name.
+ */
+const _highlight = (node, addItems, text, className) => {
+ if (node.nodeType === Node.TEXT_NODE) {
+ const val = node.nodeValue;
+ const parent = node.parentNode;
+ const pos = val.toLowerCase().indexOf(text);
+ if (
+ pos >= 0 &&
+ !parent.classList.contains(className) &&
+ !parent.classList.contains("nohighlight")
+ ) {
+ let span;
+
+ const closestNode = parent.closest("body, svg, foreignObject");
+ const isInSVG = closestNode && closestNode.matches("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.classList.add(className);
+ }
+
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ parent.insertBefore(
+ span,
+ parent.insertBefore(
+ document.createTextNode(val.substr(pos + text.length)),
+ node.nextSibling
+ )
+ );
+ node.nodeValue = val.substr(0, pos);
+
+ if (isInSVG) {
+ const rect = document.createElementNS(
+ "http://www.w3.org/2000/svg",
+ "rect"
+ );
+ const bbox = parent.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute("class", className);
+ addItems.push({ parent: parent, target: rect });
+ }
+ }
+ } else if (node.matches && !node.matches("button, select, textarea")) {
+ node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
+ }
+};
+const _highlightText = (thisNode, text, className) => {
+ let addItems = [];
+ _highlight(thisNode, addItems, text, className);
+ addItems.forEach((obj) =>
+ obj.parent.insertAdjacentElement("beforebegin", obj.target)
+ );
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const SphinxHighlight = {
+
+ /**
+ * highlight the search words provided in localstorage in the text
+ */
+ highlightSearchWords: () => {
+ if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
+
+ // get and clear terms from localstorage
+ const url = new URL(window.location);
+ const highlight =
+ localStorage.getItem("sphinx_highlight_terms")
+ || url.searchParams.get("highlight")
+ || "";
+ localStorage.removeItem("sphinx_highlight_terms")
+ url.searchParams.delete("highlight");
+ window.history.replaceState({}, "", url);
+
+ // get individual terms from highlight string
+ const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
+ if (terms.length === 0) return; // nothing to do
+
+ // There should never be more than one element matching "div.body"
+ const divBody = document.querySelectorAll("div.body");
+ const body = divBody.length ? divBody[0] : document.querySelector("body");
+ window.setTimeout(() => {
+ terms.forEach((term) => _highlightText(body, term, "highlighted"));
+ }, 10);
+
+ const searchBox = document.getElementById("searchbox");
+ if (searchBox === null) return;
+ searchBox.appendChild(
+ document
+ .createRange()
+ .createContextualFragment(
+ '<p class="highlight-link">' +
+ '<a href="javascript:SphinxHighlight.hideSearchWords()">' +
+ _("Hide Search Matches") +
+ "</a></p>"
+ )
+ );
+ },
+
+ /**
+ * helper function to hide the search marks again
+ */
+ hideSearchWords: () => {
+ document
+ .querySelectorAll("#searchbox .highlight-link")
+ .forEach((el) => el.remove());
+ document
+ .querySelectorAll("span.highlighted")
+ .forEach((el) => el.classList.remove("highlighted"));
+ localStorage.removeItem("sphinx_highlight_terms")
+ },
+
+ initEscapeListener: () => {
+ // only install a listener if it is really needed
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
+ if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
+ SphinxHighlight.hideSearchWords();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+_ready(SphinxHighlight.highlightSearchWords);
+_ready(SphinxHighlight.initEscapeListener);
diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
new file mode 100644
index 0000000000000000000000000000000000000000..5629873524a79a7c2bdac7e81cddf701736d7fb0
--- /dev/null
+++ b/docs/_build/html/genindex.html
@@ -0,0 +1,306 @@
+<!DOCTYPE html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Index — asdsd 0.1 documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
+ <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+ <script src="_static/doctools.js"></script>
+ <script src="_static/sphinx_highlight.js"></script>
+ <link rel="index" title="Index" href="#" />
+ <link rel="search" title="Search" href="search.html" />
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head><body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+
+
+ <div class="body" role="main">
+
+
+<h1 id="index">Index</h1>
+
+<div class="genindex-jumpbox">
+ <a href="#C"><strong>C</strong></a>
+ | <a href="#D"><strong>D</strong></a>
+ | <a href="#G"><strong>G</strong></a>
+ | <a href="#M"><strong>M</strong></a>
+ | <a href="#P"><strong>P</strong></a>
+ | <a href="#R"><strong>R</strong></a>
+ | <a href="#S"><strong>S</strong></a>
+ | <a href="#T"><strong>T</strong></a>
+
+</div>
+<h2 id="C">C</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="source/src.html#src.Plotter.Plotter.customize_plot">customize_plot() (src.Plotter.Plotter method)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="D">D</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="source/src.html#src.Dataset.Dataset">Dataset (class in src.Dataset)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="source/src.html#src.Plotter.Plotter.distribution_plot">distribution_plot() (src.Plotter.Plotter method)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="G">G</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="source/src.html#src.Dataset.Dataset.get_category_counts">get_category_counts() (src.Dataset.Dataset method)</a>
+</li>
+ <li><a href="source/src.html#src.Dataset.Dataset.get_combined_anxiety_score">get_combined_anxiety_score() (src.Dataset.Dataset method)</a>
+</li>
+ <li><a href="source/src.html#src.Dataset.Dataset.get_dataframe">get_dataframe() (src.Dataset.Dataset method)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="source/src.html#src.Dataset.Dataset.get_is_competitive_col">get_is_competitive_col() (src.Dataset.Dataset method)</a>
+</li>
+ <li><a href="source/src.html#src.Dataset.Dataset.get_is_narcissist_col">get_is_narcissist_col() (src.Dataset.Dataset method)</a>
+</li>
+ <li><a href="source/src.html#src.Dataset.Dataset.get_sorted_column">get_sorted_column() (src.Dataset.Dataset method)</a>
+</li>
+ <li><a href="source/src.html#src.Dataset.Dataset.get_unique_column_values">get_unique_column_values() (src.Dataset.Dataset method)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="M">M</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li>
+ module
+
+ <ul>
+ <li><a href="source/src.html#module-src">src</a>
+</li>
+ <li><a href="source/src.html#module-src.Dataset">src.Dataset</a>
+</li>
+ <li><a href="source/src.html#module-src.Plotter">src.Plotter</a>
+</li>
+ <li><a href="source/src.html#module-src.test_dataset">src.test_dataset</a>
+</li>
+ <li><a href="source/src.html#module-src.test_plotter">src.test_plotter</a>
+</li>
+ </ul></li>
+ </ul></td>
+</tr></table>
+
+<h2 id="P">P</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="source/src.html#src.Plotter.Plotter.plot_categorical_bar_chart">plot_categorical_bar_chart() (src.Plotter.Plotter method)</a>
+</li>
+ <li><a href="source/src.html#src.Plotter.Plotter.plot_categorical_boxplot">plot_categorical_boxplot() (src.Plotter.Plotter method)</a>
+</li>
+ <li><a href="source/src.html#src.Plotter.Plotter.plot_categorical_histplot">plot_categorical_histplot() (src.Plotter.Plotter method)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="source/src.html#src.Plotter.Plotter.plot_scatterplot">plot_scatterplot() (src.Plotter.Plotter method)</a>
+</li>
+ <li><a href="source/src.html#src.Plotter.Plotter">Plotter (class in src.Plotter)</a>
+</li>
+ <li><a href="source/src.html#src.Dataset.Dataset.preprocess_dataset">preprocess_dataset() (src.Dataset.Dataset method)</a>
+</li>
+ <li><a href="source/src.html#src.Dataset.Dataset.preprocess_whyplay">preprocess_whyplay() (src.Dataset.Dataset method)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="R">R</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="source/src.html#src.Dataset.Dataset.remove_nonaccepting_rows">remove_nonaccepting_rows() (src.Dataset.Dataset method)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+<h2 id="S">S</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li>
+ src
+
+ <ul>
+ <li><a href="source/src.html#module-src">module</a>
+</li>
+ </ul></li>
+ <li>
+ src.Dataset
+
+ <ul>
+ <li><a href="source/src.html#module-src.Dataset">module</a>
+</li>
+ </ul></li>
+ <li>
+ src.Plotter
+
+ <ul>
+ <li><a href="source/src.html#module-src.Plotter">module</a>
+</li>
+ </ul></li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li>
+ src.test_dataset
+
+ <ul>
+ <li><a href="source/src.html#module-src.test_dataset">module</a>
+</li>
+ </ul></li>
+ <li>
+ src.test_plotter
+
+ <ul>
+ <li><a href="source/src.html#module-src.test_plotter">module</a>
+</li>
+ </ul></li>
+ </ul></td>
+</tr></table>
+
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="source/src.html#src.test_dataset.test_bool_or_none_params">test_bool_or_none_params() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.test_catch_colname_not_in_df">test_catch_colname_not_in_df() (in module src.test_dataset)</a>
+
+ <ul>
+ <li><a href="source/src.html#src.test_plotter.test_catch_colname_not_in_df">(in module src.test_plotter)</a>
+</li>
+ </ul></li>
+ <li><a href="source/src.html#src.test_dataset.test_catch_colname_not_string">test_catch_colname_not_string() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.test_catch_non_bool">test_catch_non_bool() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.test_catch_non_dataframe">test_catch_non_dataframe() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.test_catch_plotter_init_not_Dataset">test_catch_plotter_init_not_Dataset() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.test_catch_styling_params_not_dict">test_catch_styling_params_not_dict() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.test_catch_target_not_string">test_catch_target_not_string() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.test_combined_anxiety_score">test_combined_anxiety_score() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.test_customize_plot">test_customize_plot() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.test_distribution_plot">test_distribution_plot() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.test_get_dataframe">test_get_dataframe() (in module src.test_dataset)</a>
+</li>
+ </ul></td>
+ <td style="width: 33%; vertical-align: top;"><ul>
+ <li><a href="source/src.html#src.test_dataset.test_get_is_narcissist_col">test_get_is_narcissist_col() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.test_get_sorted_columns">test_get_sorted_columns() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.test_get_unique_column_values">test_get_unique_column_values() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.test_incorrectly_load_Dataset_class">test_incorrectly_load_Dataset_class() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.test_load_Dataset_class">test_load_Dataset_class() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.test_load_plotter">test_load_plotter() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.test_plot_categorical_bar_chart">test_plot_categorical_bar_chart() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.test_plot_categorical_boxplot">test_plot_categorical_boxplot() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.test_plot_categorical_histplot">test_plot_categorical_histplot() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.test_plot_scatterplot">test_plot_scatterplot() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.test_preprocessed_dataframe">test_preprocessed_dataframe() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_dataset.the_dataset">the_dataset() (in module src.test_dataset)</a>
+</li>
+ <li><a href="source/src.html#src.test_plotter.the_plotter">the_plotter() (in module src.test_plotter)</a>
+</li>
+ <li><a href="source/src.html#src.Dataset.Dataset.treat_outliers">treat_outliers() (src.Dataset.Dataset method)</a>
+</li>
+ </ul></td>
+</tr></table>
+
+
+
+ </div>
+
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="index.html">asdsd</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+ <h3 id="searchlabel">Quick search</h3>
+ <div class="searchformwrapper">
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <input type="submit" value="Go" />
+ </form>
+ </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2023, asdasdasdadadasd.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
new file mode 100644
index 0000000000000000000000000000000000000000..eef5e0db660cc89d70a8b15f679376c5fd7f04c1
--- /dev/null
+++ b/docs/_build/html/index.html
@@ -0,0 +1,109 @@
+<!DOCTYPE html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+ <title>Welcome to asdsd’s documentation! — asdsd 0.1 documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
+ <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+ <script src="_static/doctools.js"></script>
+ <script src="_static/sphinx_highlight.js"></script>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head><body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+
+
+ <div class="body" role="main">
+
+ <section id="welcome-to-asdsd-s-documentation">
+<h1>Welcome to asdsd’s documentation!<a class="headerlink" href="#welcome-to-asdsd-s-documentation" title="Permalink to this heading">¶</a></h1>
+<div class="toctree-wrapper compound">
+</div>
+</section>
+<section id="indices-and-tables">
+<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading">¶</a></h1>
+<ul class="simple">
+<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
+<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
+<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
+</ul>
+</section>
+
+
+ </div>
+
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="#">asdsd</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="#">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+ <h3 id="searchlabel">Quick search</h3>
+ <div class="searchformwrapper">
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <input type="submit" value="Go" />
+ </form>
+ </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2023, asdasdasdadadasd.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+
+ |
+ <a href="_sources/index.rst.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
new file mode 100644
index 0000000000000000000000000000000000000000..332a1e7a37f389cdd01a2ab576ca2f8c8884f7c0
--- /dev/null
+++ b/docs/_build/html/objects.inv
@@ -0,0 +1,8 @@
+# Sphinx inventory version 2
+# Project: asdsd
+# Version:
+# The remainder of this file is compressed using zlib.
+xÚ–±’Û †{?™¤µ“k¯¾&Ef<“"%ƒam1A °«;+U^#¯—'É"ìX:Û9©²ü ì²ÚßµhºÇ:˜Öø$0´QÃGŒzUQíÞç‰å±\¤±'E
+
+$C©v
+Q<œ)¯HV; ©Á.ÄNêÐzÂþ@U0÷rB½± ŒT~o:‰:D(Æ~ÞFU—,¦35@–ì3𳛂ò*j‹h‘&‘0Dâ 1¢}1¥õöG Š|V®…²‹k"41h@ì~¬À ˜—ªkœêŠ0êÀ7åƒWZCCÖïd /e¡QE2´ä,ÄÛkˆ Þó $Cé[ á+ÉJ·H¡¶?A6<rÏAÿý.Ëh7-ÙàË)IxlV+'7*J]©8.ìç;[Å!O£!ãøåfÒè+¹±D†ºü² ÁÉS¡ó¥+îr}}n[¯Ó
Þx†üÂAè*uϽ’‰Ü¬¼4Ûy©´ün"CíÞ3r†2ÖU«*ÂÙU1å¢ÏÓF^ƒ“P× §h=§;‚&×I”‘‡–-sç,ÅΈ:ùçoÚÕV0ì·Ê›ûh¨›5\à †˜e©‡>‡7Ä"u.ù}n‡=ØX=•J*¦ò-kccÞ™Ka.:u©/÷AAþoù3!O¶?phýåÄWö7¨‚;²¿o½½@2NmÀ‰åƒ8ŽöëÄçô¸8-3A§EƒßÀ±u 4~ýFÁËÚ<©´ý»w… ;5Ýò8‘Q_rWÉ{fß;þ“äÇj¶¬j,ÌcYó5ϯՇÜäÖ…Ã0Ç3YÉ)\œ²yaõ1Çi¥h”þžöø ¹—®q
\ No newline at end of file
diff --git a/docs/_build/html/py-modindex.html b/docs/_build/html/py-modindex.html
new file mode 100644
index 0000000000000000000000000000000000000000..0b231f462ef2b5d6bbf2bce8aa0b283e165d9a21
--- /dev/null
+++ b/docs/_build/html/py-modindex.html
@@ -0,0 +1,133 @@
+<!DOCTYPE html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Python Module Index — asdsd 0.1 documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
+ <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+ <script src="_static/doctools.js"></script>
+ <script src="_static/sphinx_highlight.js"></script>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="search.html" />
+
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+
+
+ </head><body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+
+
+ <div class="body" role="main">
+
+
+ <h1>Python Module Index</h1>
+
+ <div class="modindex-jumpbox">
+ <a href="#cap-s"><strong>s</strong></a>
+ </div>
+
+ <table class="indextable modindextable">
+ <tr class="pcap"><td></td><td> </td><td></td></tr>
+ <tr class="cap" id="cap-s"><td></td><td>
+ <strong>s</strong></td><td></td></tr>
+ <tr>
+ <td><img src="_static/minus.png" class="toggler"
+ id="toggle-1" style="display: none" alt="-" /></td>
+ <td>
+ <a href="source/src.html#module-src"><code class="xref">src</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="source/src.html#module-src.Dataset"><code class="xref">src.Dataset</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="source/src.html#module-src.Plotter"><code class="xref">src.Plotter</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="source/src.html#module-src.test_dataset"><code class="xref">src.test_dataset</code></a></td><td>
+ <em></em></td></tr>
+ <tr class="cg-1">
+ <td></td>
+ <td>   
+ <a href="source/src.html#module-src.test_plotter"><code class="xref">src.test_plotter</code></a></td><td>
+ <em></em></td></tr>
+ </table>
+
+
+ </div>
+
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="index.html">asdsd</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+ <h3 id="searchlabel">Quick search</h3>
+ <div class="searchformwrapper">
+ <form class="search" action="search.html" method="get">
+ <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <input type="submit" value="Go" />
+ </form>
+ </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2023, asdasdasdadadasd.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/search.html b/docs/_build/html/search.html
new file mode 100644
index 0000000000000000000000000000000000000000..09453b1e7dcfc3e33654dd8d56954ab34a3bdc00
--- /dev/null
+++ b/docs/_build/html/search.html
@@ -0,0 +1,117 @@
+<!DOCTYPE html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>Search — asdsd 0.1 documentation</title>
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
+
+ <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+ <script src="_static/doctools.js"></script>
+ <script src="_static/sphinx_highlight.js"></script>
+ <script src="_static/searchtools.js"></script>
+ <script src="_static/language_data.js"></script>
+ <link rel="index" title="Index" href="genindex.html" />
+ <link rel="search" title="Search" href="#" />
+ <script src="searchindex.js" defer></script>
+
+
+ <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+
+ </head><body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+
+
+ <div class="body" role="main">
+
+ <h1 id="search-documentation">Search</h1>
+
+ <noscript>
+ <div class="admonition warning">
+ <p>
+ Please activate JavaScript to enable the search
+ functionality.
+ </p>
+ </div>
+ </noscript>
+
+
+ <p>
+ Searching for multiple words only shows matches that contain
+ all words.
+ </p>
+
+
+ <form action="" method="get">
+ <input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <input type="submit" value="search" />
+ <span id="search-progress" style="padding-left: 10px"></span>
+ </form>
+
+
+
+ <div id="search-results">
+
+ </div>
+
+
+ </div>
+
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="index.html">asdsd</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2023, asdasdasdadadasd.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
new file mode 100644
index 0000000000000000000000000000000000000000..97b0265e1dba67dc2a651d04c52d4bb50bc7d2d8
--- /dev/null
+++ b/docs/_build/html/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"docnames": ["index", "source/modules", "source/src"], "filenames": ["index.rst", "source/modules.rst", "source/src.rst"], "titles": ["Welcome to asdsd\u2019s documentation!", "src", "src package"], "terms": {"index": 0, "modul": [0, 1], "search": 0, "page": 0, "packag": 1, "submodul": 1, "dataset": 1, "get_category_count": [1, 2], "get_combined_anxiety_scor": [1, 2], "get_datafram": [1, 2], "get_is_competitive_col": [1, 2], "get_is_narcissist_col": [1, 2], "get_sorted_column": [1, 2], "get_unique_column_valu": [1, 2], "preprocess_dataset": [1, 2], "preprocess_whyplai": [1, 2], "remove_nonaccepting_row": [1, 2], "treat_outli": [1, 2], "plotter": 1, "customize_plot": [1, 2], "distribution_plot": [1, 2], "plot_categorical_bar_chart": [1, 2], "plot_categorical_boxplot": [1, 2], "plot_categorical_histplot": [1, 2], "plot_scatterplot": [1, 2], "test_dataset": 1, "test_bool_or_none_param": [1, 2], "test_catch_colname_not_in_df": [1, 2], "test_catch_colname_not_str": [1, 2], "test_catch_non_bool": [1, 2], "test_catch_non_datafram": [1, 2], "test_combined_anxiety_scor": [1, 2], "test_get_datafram": [1, 2], "test_get_is_narcissist_col": [1, 2], "test_get_sorted_column": [1, 2], "test_get_unique_column_valu": [1, 2], "test_incorrectly_load_dataset_class": [1, 2], "test_load_dataset_class": [1, 2], "test_preprocessed_datafram": [1, 2], "the_dataset": [1, 2], "test_plott": 1, "test_catch_plotter_init_not_dataset": [1, 2], "test_catch_styling_params_not_dict": [1, 2], "test_catch_target_not_str": [1, 2], "test_customize_plot": [1, 2], "test_distribution_plot": [1, 2], "test_load_plott": [1, 2], "test_plot_categorical_bar_chart": [1, 2], "test_plot_categorical_boxplot": [1, 2], "test_plot_categorical_histplot": [1, 2], "test_plot_scatterplot": [1, 2], "the_plott": [1, 2], "content": 1, "class": 2, "dataset_filenam": 2, "str": 2, "base": 2, "object": 2, "colnam": 2, "ascend": 2, "bool": 2, "none": 2, "seri": 2, "return": 2, "count": 2, "categor": 2, "valu": 2, "paramet": 2, "column": 2, "name": 2, "option": 2, "direct": 2, "sort": 2, "result": 2, "If": 2, "set": 2, "ar": 2, "default": 2, "categori": 2, "type": 2, "pd": 2, "datafram": 2, "get": 2, "combin": 2, "anxieti": 2, "score": 2, "thi": 2, "i": 2, "gan": 2, "spin": 2, "swl": 2, "metric": 2, "each": 2, "three": 2, "first": 2, "normalis": 2, "mean": 2, "A": 2, "getter": 2, "function": 2, "boolean": 2, "narcissist": 2, "The": 2, "narciss": 2, "1": 2, "0": 2, "consid": 2, "Not": 2, "while": 2, "all": 2, "abov": 2, "true": 2, "singl": 2, "either": 2, "descend": 2, "see": 2, "get_dataset_column": 2, "order": 2, "an": 2, "arrai": 2, "string": 2, "contain": 2, "uniqu": 2, "present": 2, "raw_datafram": 2, "preprocess": 2, "immedi": 2, "after": 2, "load": 2, "raw": 2, "read": 2, "from": 2, "read_csv": 2, "discard": 2, "afterward": 2, "whyplai": 2, "is_competit": 2, "col": 2, "remov": 2, "row": 2, "where": 2, "particip": 2, "did": 2, "consent": 2, "data": 2, "process": 2, "df": 2, "treat": 2, "outlier": 2, "numer": 2, "filter": 2, "fig": 2, "ax": 2, "styling_param": 2, "plt": 2, "figur": 2, "dict": 2, "target": 2, "plot": 2, "distribut": 2, "must": 2, "category1": 2, "category2": 2, "bar": 2, "chart": 2, "boxplot": 2, "bin": 2, "30": 2, "hisplot": 2, "target1": 2, "target2": 2, "scatterplot": 2, "test": 2, "file": 2, "py": 2, "param": 2, "take": 2, "correctli": 2, "work": 2, "intend": 2, "catch": 2, "incorrect": 2, "input": 2, "successfulli": 2, "": 2, "init": 2, "actual": 2, "non": 2, "dictionari": 2, "can": 2, "initialis": 2, "instanc": 2, "fixtur": 2}, "objects": {"": [[2, 0, 0, "-", "src"]], "src": [[2, 0, 0, "-", "Dataset"], [2, 0, 0, "-", "Plotter"], [2, 0, 0, "-", "test_dataset"], [2, 0, 0, "-", "test_plotter"]], "src.Dataset": [[2, 1, 1, "", "Dataset"]], "src.Dataset.Dataset": [[2, 2, 1, "", "get_category_counts"], [2, 2, 1, "", "get_combined_anxiety_score"], [2, 2, 1, "", "get_dataframe"], [2, 2, 1, "", "get_is_competitive_col"], [2, 2, 1, "", "get_is_narcissist_col"], [2, 2, 1, "", "get_sorted_column"], [2, 2, 1, "", "get_unique_column_values"], [2, 2, 1, "", "preprocess_dataset"], [2, 2, 1, "", "preprocess_whyplay"], [2, 2, 1, "", "remove_nonaccepting_rows"], [2, 2, 1, "", "treat_outliers"]], "src.Plotter": [[2, 1, 1, "", "Plotter"]], "src.Plotter.Plotter": [[2, 2, 1, "", "customize_plot"], [2, 2, 1, "", "distribution_plot"], [2, 2, 1, "", "plot_categorical_bar_chart"], [2, 2, 1, "", "plot_categorical_boxplot"], [2, 2, 1, "", "plot_categorical_histplot"], [2, 2, 1, "", "plot_scatterplot"]], "src.test_dataset": [[2, 3, 1, "", "test_bool_or_none_params"], [2, 3, 1, "", "test_catch_colname_not_in_df"], [2, 3, 1, "", "test_catch_colname_not_string"], [2, 3, 1, "", "test_catch_non_bool"], [2, 3, 1, "", "test_catch_non_dataframe"], [2, 3, 1, "", "test_combined_anxiety_score"], [2, 3, 1, "", "test_get_dataframe"], [2, 3, 1, "", "test_get_is_narcissist_col"], [2, 3, 1, "", "test_get_sorted_columns"], [2, 3, 1, "", "test_get_unique_column_values"], [2, 3, 1, "", "test_incorrectly_load_Dataset_class"], [2, 3, 1, "", "test_load_Dataset_class"], [2, 3, 1, "", "test_preprocessed_dataframe"], [2, 3, 1, "", "the_dataset"]], "src.test_plotter": [[2, 3, 1, "", "test_catch_colname_not_in_df"], [2, 3, 1, "", "test_catch_plotter_init_not_Dataset"], [2, 3, 1, "", "test_catch_styling_params_not_dict"], [2, 3, 1, "", "test_catch_target_not_string"], [2, 3, 1, "", "test_customize_plot"], [2, 3, 1, "", "test_distribution_plot"], [2, 3, 1, "", "test_load_plotter"], [2, 3, 1, "", "test_plot_categorical_bar_chart"], [2, 3, 1, "", "test_plot_categorical_boxplot"], [2, 3, 1, "", "test_plot_categorical_histplot"], [2, 3, 1, "", "test_plot_scatterplot"], [2, 3, 1, "", "the_plotter"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"]}, "titleterms": {"welcom": 0, "asdsd": 0, "": 0, "document": 0, "indic": 0, "tabl": 0, "src": [1, 2], "packag": 2, "submodul": 2, "dataset": 2, "modul": 2, "plotter": 2, "test_dataset": 2, "test_plott": 2, "content": 2}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Welcome to asdsd\u2019s documentation!": [[0, "welcome-to-asdsd-s-documentation"]], "Indices and tables": [[0, "indices-and-tables"]], "src": [[1, "src"]], "src package": [[2, "src-package"]], "Submodules": [[2, "submodules"]], "src.Dataset module": [[2, "module-src.Dataset"]], "src.Plotter module": [[2, "module-src.Plotter"]], "src.test_dataset module": [[2, "module-src.test_dataset"]], "src.test_plotter module": [[2, "module-src.test_plotter"]], "Module contents": [[2, "module-src"]]}, "indexentries": {"dataset (class in src.dataset)": [[2, "src.Dataset.Dataset"]], "plotter (class in src.plotter)": [[2, "src.Plotter.Plotter"]], "customize_plot() (src.plotter.plotter method)": [[2, "src.Plotter.Plotter.customize_plot"]], "distribution_plot() (src.plotter.plotter method)": [[2, "src.Plotter.Plotter.distribution_plot"]], "get_category_counts() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.get_category_counts"]], "get_combined_anxiety_score() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.get_combined_anxiety_score"]], "get_dataframe() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.get_dataframe"]], "get_is_competitive_col() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.get_is_competitive_col"]], "get_is_narcissist_col() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.get_is_narcissist_col"]], "get_sorted_column() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.get_sorted_column"]], "get_unique_column_values() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.get_unique_column_values"]], "module": [[2, "module-src"], [2, "module-src.Dataset"], [2, "module-src.Plotter"], [2, "module-src.test_dataset"], [2, "module-src.test_plotter"]], "plot_categorical_bar_chart() (src.plotter.plotter method)": [[2, "src.Plotter.Plotter.plot_categorical_bar_chart"]], "plot_categorical_boxplot() (src.plotter.plotter method)": [[2, "src.Plotter.Plotter.plot_categorical_boxplot"]], "plot_categorical_histplot() (src.plotter.plotter method)": [[2, "src.Plotter.Plotter.plot_categorical_histplot"]], "plot_scatterplot() (src.plotter.plotter method)": [[2, "src.Plotter.Plotter.plot_scatterplot"]], "preprocess_dataset() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.preprocess_dataset"]], "preprocess_whyplay() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.preprocess_whyplay"]], "remove_nonaccepting_rows() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.remove_nonaccepting_rows"]], "src": [[2, "module-src"]], "src.dataset": [[2, "module-src.Dataset"]], "src.plotter": [[2, "module-src.Plotter"]], "src.test_dataset": [[2, "module-src.test_dataset"]], "src.test_plotter": [[2, "module-src.test_plotter"]], "test_bool_or_none_params() (in module src.test_dataset)": [[2, "src.test_dataset.test_bool_or_none_params"]], "test_catch_colname_not_in_df() (in module src.test_dataset)": [[2, "src.test_dataset.test_catch_colname_not_in_df"]], "test_catch_colname_not_in_df() (in module src.test_plotter)": [[2, "src.test_plotter.test_catch_colname_not_in_df"]], "test_catch_colname_not_string() (in module src.test_dataset)": [[2, "src.test_dataset.test_catch_colname_not_string"]], "test_catch_non_bool() (in module src.test_dataset)": [[2, "src.test_dataset.test_catch_non_bool"]], "test_catch_non_dataframe() (in module src.test_dataset)": [[2, "src.test_dataset.test_catch_non_dataframe"]], "test_catch_plotter_init_not_dataset() (in module src.test_plotter)": [[2, "src.test_plotter.test_catch_plotter_init_not_Dataset"]], "test_catch_styling_params_not_dict() (in module src.test_plotter)": [[2, "src.test_plotter.test_catch_styling_params_not_dict"]], "test_catch_target_not_string() (in module src.test_plotter)": [[2, "src.test_plotter.test_catch_target_not_string"]], "test_combined_anxiety_score() (in module src.test_dataset)": [[2, "src.test_dataset.test_combined_anxiety_score"]], "test_customize_plot() (in module src.test_plotter)": [[2, "src.test_plotter.test_customize_plot"]], "test_distribution_plot() (in module src.test_plotter)": [[2, "src.test_plotter.test_distribution_plot"]], "test_get_dataframe() (in module src.test_dataset)": [[2, "src.test_dataset.test_get_dataframe"]], "test_get_is_narcissist_col() (in module src.test_dataset)": [[2, "src.test_dataset.test_get_is_narcissist_col"]], "test_get_sorted_columns() (in module src.test_dataset)": [[2, "src.test_dataset.test_get_sorted_columns"]], "test_get_unique_column_values() (in module src.test_dataset)": [[2, "src.test_dataset.test_get_unique_column_values"]], "test_incorrectly_load_dataset_class() (in module src.test_dataset)": [[2, "src.test_dataset.test_incorrectly_load_Dataset_class"]], "test_load_dataset_class() (in module src.test_dataset)": [[2, "src.test_dataset.test_load_Dataset_class"]], "test_load_plotter() (in module src.test_plotter)": [[2, "src.test_plotter.test_load_plotter"]], "test_plot_categorical_bar_chart() (in module src.test_plotter)": [[2, "src.test_plotter.test_plot_categorical_bar_chart"]], "test_plot_categorical_boxplot() (in module src.test_plotter)": [[2, "src.test_plotter.test_plot_categorical_boxplot"]], "test_plot_categorical_histplot() (in module src.test_plotter)": [[2, "src.test_plotter.test_plot_categorical_histplot"]], "test_plot_scatterplot() (in module src.test_plotter)": [[2, "src.test_plotter.test_plot_scatterplot"]], "test_preprocessed_dataframe() (in module src.test_dataset)": [[2, "src.test_dataset.test_preprocessed_dataframe"]], "the_dataset() (in module src.test_dataset)": [[2, "src.test_dataset.the_dataset"]], "the_plotter() (in module src.test_plotter)": [[2, "src.test_plotter.the_plotter"]], "treat_outliers() (src.dataset.dataset method)": [[2, "src.Dataset.Dataset.treat_outliers"]]}})
\ No newline at end of file
diff --git a/docs/_build/html/source/modules.html b/docs/_build/html/source/modules.html
new file mode 100644
index 0000000000000000000000000000000000000000..7e51a8d4c9fec5fd7d313a0f5c114397d1b405ca
--- /dev/null
+++ b/docs/_build/html/source/modules.html
@@ -0,0 +1,169 @@
+<!DOCTYPE html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+ <title>src — asdsd 0.1 documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
+ <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+ <script src="../_static/doctools.js"></script>
+ <script src="../_static/sphinx_highlight.js"></script>
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head><body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+
+
+ <div class="body" role="main">
+
+ <section id="src">
+<h1>src<a class="headerlink" href="#src" title="Permalink to this heading">¶</a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="src.html">src package</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="src.html#submodules">Submodules</a></li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.Dataset">src.Dataset module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.Dataset.Dataset"><code class="docutils literal notranslate"><span class="pre">Dataset</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.get_category_counts"><code class="docutils literal notranslate"><span class="pre">Dataset.get_category_counts()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.get_combined_anxiety_score"><code class="docutils literal notranslate"><span class="pre">Dataset.get_combined_anxiety_score()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.get_dataframe"><code class="docutils literal notranslate"><span class="pre">Dataset.get_dataframe()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.get_is_competitive_col"><code class="docutils literal notranslate"><span class="pre">Dataset.get_is_competitive_col()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.get_is_narcissist_col"><code class="docutils literal notranslate"><span class="pre">Dataset.get_is_narcissist_col()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.get_sorted_column"><code class="docutils literal notranslate"><span class="pre">Dataset.get_sorted_column()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.get_unique_column_values"><code class="docutils literal notranslate"><span class="pre">Dataset.get_unique_column_values()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.preprocess_dataset"><code class="docutils literal notranslate"><span class="pre">Dataset.preprocess_dataset()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.preprocess_whyplay"><code class="docutils literal notranslate"><span class="pre">Dataset.preprocess_whyplay()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.remove_nonaccepting_rows"><code class="docutils literal notranslate"><span class="pre">Dataset.remove_nonaccepting_rows()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Dataset.Dataset.treat_outliers"><code class="docutils literal notranslate"><span class="pre">Dataset.treat_outliers()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.Plotter">src.Plotter module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.Plotter.Plotter"><code class="docutils literal notranslate"><span class="pre">Plotter</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Plotter.Plotter.customize_plot"><code class="docutils literal notranslate"><span class="pre">Plotter.customize_plot()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Plotter.Plotter.distribution_plot"><code class="docutils literal notranslate"><span class="pre">Plotter.distribution_plot()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Plotter.Plotter.plot_categorical_bar_chart"><code class="docutils literal notranslate"><span class="pre">Plotter.plot_categorical_bar_chart()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Plotter.Plotter.plot_categorical_boxplot"><code class="docutils literal notranslate"><span class="pre">Plotter.plot_categorical_boxplot()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Plotter.Plotter.plot_categorical_histplot"><code class="docutils literal notranslate"><span class="pre">Plotter.plot_categorical_histplot()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="src.html#src.Plotter.Plotter.plot_scatterplot"><code class="docutils literal notranslate"><span class="pre">Plotter.plot_scatterplot()</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.test_dataset">src.test_dataset module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_bool_or_none_params"><code class="docutils literal notranslate"><span class="pre">test_bool_or_none_params()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_catch_colname_not_in_df"><code class="docutils literal notranslate"><span class="pre">test_catch_colname_not_in_df()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_catch_colname_not_string"><code class="docutils literal notranslate"><span class="pre">test_catch_colname_not_string()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_catch_non_bool"><code class="docutils literal notranslate"><span class="pre">test_catch_non_bool()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_catch_non_dataframe"><code class="docutils literal notranslate"><span class="pre">test_catch_non_dataframe()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_combined_anxiety_score"><code class="docutils literal notranslate"><span class="pre">test_combined_anxiety_score()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_get_dataframe"><code class="docutils literal notranslate"><span class="pre">test_get_dataframe()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_get_is_narcissist_col"><code class="docutils literal notranslate"><span class="pre">test_get_is_narcissist_col()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_get_sorted_columns"><code class="docutils literal notranslate"><span class="pre">test_get_sorted_columns()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_get_unique_column_values"><code class="docutils literal notranslate"><span class="pre">test_get_unique_column_values()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_incorrectly_load_Dataset_class"><code class="docutils literal notranslate"><span class="pre">test_incorrectly_load_Dataset_class()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_load_Dataset_class"><code class="docutils literal notranslate"><span class="pre">test_load_Dataset_class()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.test_preprocessed_dataframe"><code class="docutils literal notranslate"><span class="pre">test_preprocessed_dataframe()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_dataset.the_dataset"><code class="docutils literal notranslate"><span class="pre">the_dataset()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src.test_plotter">src.test_plotter module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_catch_colname_not_in_df"><code class="docutils literal notranslate"><span class="pre">test_catch_colname_not_in_df()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_catch_plotter_init_not_Dataset"><code class="docutils literal notranslate"><span class="pre">test_catch_plotter_init_not_Dataset()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_catch_styling_params_not_dict"><code class="docutils literal notranslate"><span class="pre">test_catch_styling_params_not_dict()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_catch_target_not_string"><code class="docutils literal notranslate"><span class="pre">test_catch_target_not_string()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_customize_plot"><code class="docutils literal notranslate"><span class="pre">test_customize_plot()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_distribution_plot"><code class="docutils literal notranslate"><span class="pre">test_distribution_plot()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_load_plotter"><code class="docutils literal notranslate"><span class="pre">test_load_plotter()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_plot_categorical_bar_chart"><code class="docutils literal notranslate"><span class="pre">test_plot_categorical_bar_chart()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_plot_categorical_boxplot"><code class="docutils literal notranslate"><span class="pre">test_plot_categorical_boxplot()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_plot_categorical_histplot"><code class="docutils literal notranslate"><span class="pre">test_plot_categorical_histplot()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.test_plot_scatterplot"><code class="docutils literal notranslate"><span class="pre">test_plot_scatterplot()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="src.html#src.test_plotter.the_plotter"><code class="docutils literal notranslate"><span class="pre">the_plotter()</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="src.html#module-src">Module contents</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</section>
+
+
+ </div>
+
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">asdsd</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+ <h3 id="searchlabel">Quick search</h3>
+ <div class="searchformwrapper">
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <input type="submit" value="Go" />
+ </form>
+ </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2023, asdasdasdadadasd.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+
+ |
+ <a href="../_sources/source/modules.rst.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/_build/html/source/src.html b/docs/_build/html/source/src.html
new file mode 100644
index 0000000000000000000000000000000000000000..2f01235c85941efcace6a1c3e23135c63dae37c9
--- /dev/null
+++ b/docs/_build/html/source/src.html
@@ -0,0 +1,589 @@
+<!DOCTYPE html>
+
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+ <title>src package — asdsd 0.1 documentation</title>
+ <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+ <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
+ <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
+ <script src="../_static/doctools.js"></script>
+ <script src="../_static/sphinx_highlight.js"></script>
+ <link rel="index" title="Index" href="../genindex.html" />
+ <link rel="search" title="Search" href="../search.html" />
+
+ <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+ </head><body>
+
+
+ <div class="document">
+ <div class="documentwrapper">
+ <div class="bodywrapper">
+
+
+ <div class="body" role="main">
+
+ <section id="src-package">
+<h1>src package<a class="headerlink" href="#src-package" title="Permalink to this heading">¶</a></h1>
+<section id="submodules">
+<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading">¶</a></h2>
+</section>
+<section id="module-src.Dataset">
+<span id="src-dataset-module"></span><h2>src.Dataset module<a class="headerlink" href="#module-src.Dataset" title="Permalink to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="src.Dataset.Dataset">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">src.Dataset.</span></span><span class="sig-name descname"><span class="pre">Dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset_filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.Dataset.Dataset" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.get_category_counts">
+<span class="sig-name descname"><span class="pre">get_category_counts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">colname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ascending</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Series</span></span></span><a class="headerlink" href="#src.Dataset.Dataset.get_category_counts" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns a count of categorical values in the dataset.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>colname</strong> (<em>str</em>) – the column name.</p></li>
+<li><p><strong>ascending</strong> (<em>bool</em><em>, </em><em>optional</em>) – Direction to sort results.
+If set to None, the results are not sorted. Defaults to None.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>the counted categories.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>pd.Series</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.get_combined_anxiety_score">
+<span class="sig-name descname"><span class="pre">get_combined_anxiety_score</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataframe</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Series</span></span></span><a class="headerlink" href="#src.Dataset.Dataset.get_combined_anxiety_score" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get the combined anxiety score, as a column.
+This score is based on the GAN, SPIN and SWL metrics.
+Each of the three columns are first normalised,
+then the mean is returned.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>dataframe</strong> (<em>pd.DataFrame</em>) – the dataframe.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>the anxiety score column.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>pd.Series</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.get_dataframe">
+<span class="sig-name descname"><span class="pre">get_dataframe</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#src.Dataset.Dataset.get_dataframe" title="Permalink to this definition">¶</a></dt>
+<dd><p>A getter function for the dataframe.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>the dataset.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>pd.DataFrame</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.get_is_competitive_col">
+<span class="sig-name descname"><span class="pre">get_is_competitive_col</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataframe</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.Dataset.Dataset.get_is_competitive_col" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.get_is_narcissist_col">
+<span class="sig-name descname"><span class="pre">get_is_narcissist_col</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataframe</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Series</span></span></span><a class="headerlink" href="#src.Dataset.Dataset.get_is_narcissist_col" title="Permalink to this definition">¶</a></dt>
+<dd><p>Get a boolean narcissist column.
+The Narcissism score of 1.0 is considered Not a Narcissist,
+while all values above that are above are considered Narcissist.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>dataframe</strong> (<em>pd.DataFrame</em>) – the dataframe</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>the boolean narcissist column.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>pd.Series</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.get_sorted_column">
+<span class="sig-name descname"><span class="pre">get_sorted_column</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">colname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ascending</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Series</span></span></span><a class="headerlink" href="#src.Dataset.Dataset.get_sorted_column" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns a single column, sorted either ascending or descending.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>colname</strong> (<em>str</em>) – the column name (see get_dataset_columns()).</p></li>
+<li><p><strong>ascending</strong> (<em>bool</em><em>, </em><em>optional</em>) – Sorting order. Defaults to True.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The sorted column.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>pd.Series</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.get_unique_column_values">
+<span class="sig-name descname"><span class="pre">get_unique_column_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">colname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.Dataset.Dataset.get_unique_column_values" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns a count of categorical values in the dataset.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>colname</strong> (<em>str</em>) – the column name.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>an array of strings containing the unique values
+present in the column</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>string array</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.preprocess_dataset">
+<span class="sig-name descname"><span class="pre">preprocess_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_dataframe</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#src.Dataset.Dataset.preprocess_dataset" title="Permalink to this definition">¶</a></dt>
+<dd><p>preprocess dataframe immediately after loading it.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>raw_dataframe</strong> (<em>pd.DataFrame</em>) – raw dataframe as read from pd.read_csv().
+This dataframe is discarded afterwards.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>resulting preprocessed dataframe.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>pd.DataFrame</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.preprocess_whyplay">
+<span class="sig-name descname"><span class="pre">preprocess_whyplay</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataframe</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Series</span></span></span><a class="headerlink" href="#src.Dataset.Dataset.preprocess_whyplay" title="Permalink to this definition">¶</a></dt>
+<dd><p>Preprocesses the whyplay column, and returns a Is_competitive col.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>dataframe</strong> (<em>pd.DataFrame</em>) – the dataframe.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>the Is_competitive column.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>pd.Series</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.remove_nonaccepting_rows">
+<span class="sig-name descname"><span class="pre">remove_nonaccepting_rows</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataframe</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#src.Dataset.Dataset.remove_nonaccepting_rows" title="Permalink to this definition">¶</a></dt>
+<dd><p>Removes rows where participants did not consent to data processing.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>dataframe</strong> (<em>pd.DataFrame</em>) – the dataframe.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>the dataframe.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>pd.DataFrame</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Dataset.Dataset.treat_outliers">
+<span class="sig-name descname"><span class="pre">treat_outliers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">df</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#src.Dataset.Dataset.treat_outliers" title="Permalink to this definition">¶</a></dt>
+<dd><p>Treat outliers of numerical columns.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>df</strong> (<em>pd.DataFrame</em>) – the dataframe.</p></li>
+<li><p><strong>colname</strong> (<em>str</em>) – the column name to treat.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>the filtered dataframe.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>pd.DataFrame</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+<section id="module-src.Plotter">
+<span id="src-plotter-module"></span><h2>src.Plotter module<a class="headerlink" href="#module-src.Plotter" title="Permalink to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="src.Plotter.Plotter">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">src.Plotter.</span></span><span class="sig-name descname"><span class="pre">Plotter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.Plotter.Plotter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Plotter.Plotter.customize_plot">
+<span class="sig-name descname"><span class="pre">customize_plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fig</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ax</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">styling_params</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#src.Plotter.Plotter.customize_plot" title="Permalink to this definition">¶</a></dt>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>fig</strong> (<em>plt.figure.Figure</em>) – </p></li>
+<li><p><strong>ax</strong> (<em>plt.axes.Axes</em>) – </p></li>
+<li><p><strong>styling_params</strong> (<em>dict</em>) – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Plotter.Plotter.distribution_plot">
+<span class="sig-name descname"><span class="pre">distribution_plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">styling_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#src.Plotter.Plotter.distribution_plot" title="Permalink to this definition">¶</a></dt>
+<dd><p>plot a distribution plot.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>target</strong> (<em>str</em><em>, </em><em>must be present as a column in the dataset</em>) – </p></li>
+<li><p><strong>styling_params</strong> (<em>dict</em>) – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Plotter.Plotter.plot_categorical_bar_chart">
+<span class="sig-name descname"><span class="pre">plot_categorical_bar_chart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">category1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">styling_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#src.Plotter.Plotter.plot_categorical_bar_chart" title="Permalink to this definition">¶</a></dt>
+<dd><p>plot a categorical bar chart.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>category1</strong> (<em>str</em><em>, </em><em>must be present as a column in the dataset</em>) – </p></li>
+<li><p><strong>category2</strong> (<em>str</em><em>, </em><em>must be present as a column in the dataset</em>) – </p></li>
+<li><p><strong>styling_params</strong> (<em>dict</em>) – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Plotter.Plotter.plot_categorical_boxplot">
+<span class="sig-name descname"><span class="pre">plot_categorical_boxplot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">styling_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#src.Plotter.Plotter.plot_categorical_boxplot" title="Permalink to this definition">¶</a></dt>
+<dd><p>plot a categorical boxplot.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>target</strong> (<em>str</em><em>, </em><em>must be present as a column in the dataset</em>) – </p></li>
+<li><p><strong>category</strong> (<em>str</em><em>, </em><em>must be present as a column in the dataset</em>) – </p></li>
+<li><p><strong>styling_params</strong> (<em>dict</em>) – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Plotter.Plotter.plot_categorical_histplot">
+<span class="sig-name descname"><span class="pre">plot_categorical_histplot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">styling_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bins</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">30</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#src.Plotter.Plotter.plot_categorical_histplot" title="Permalink to this definition">¶</a></dt>
+<dd><p>plot a categorical hisplot.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>target</strong> (<em>str</em><em>, </em><em>must be present as a column in the dataset</em>) – </p></li>
+<li><p><strong>category</strong> (<em>str</em><em>, </em><em>must be present as a column in the dataset</em>) – </p></li>
+<li><p><strong>styling_params</strong> (<em>dict</em>) – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="src.Plotter.Plotter.plot_scatterplot">
+<span class="sig-name descname"><span class="pre">plot_scatterplot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">target2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">styling_params</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#src.Plotter.Plotter.plot_scatterplot" title="Permalink to this definition">¶</a></dt>
+<dd><p>plot a scatterplot.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>target1</strong> (<em>str</em><em>, </em><em>must be present as a column in the dataset</em>) – </p></li>
+<li><p><strong>target2</strong> (<em>str</em><em>, </em><em>must be present as a column in the dataset</em>) – </p></li>
+<li><p><strong>styling_params</strong> (<em>dict</em>) – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+<section id="module-src.test_dataset">
+<span id="src-test-dataset-module"></span><h2>src.test_dataset module<a class="headerlink" href="#module-src.test_dataset" title="Permalink to this heading">¶</a></h2>
+<p>This test file tests the Dataset class in Dataset.py.</p>
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_bool_or_none_params">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_bool_or_none_params</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">param</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_bool_or_none_params" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that functions that take bool or None correctly
+work as intended.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_catch_colname_not_in_df">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_catch_colname_not_in_df</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_catch_colname_not_in_df" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that functions that take colname correctly
+catch colnames not in dataset.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_catch_colname_not_string">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_catch_colname_not_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_catch_colname_not_string" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that functions that take colname correctly
+catch colnames not in dataset.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_catch_non_bool">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_catch_non_bool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">param</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_catch_non_bool" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that functions that take bool or None correctly
+catch incorrect input data types.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_catch_non_dataframe">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_catch_non_dataframe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">param</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_catch_non_dataframe" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that functions that take pd.DataFrame correctly
+catch incorrect input data types.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_combined_anxiety_score">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_combined_anxiety_score</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_combined_anxiety_score" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests Dataset.get_combined_anxiety_score().</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_get_dataframe">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_get_dataframe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_get_dataframe" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests Dataset.get_dataframe().</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_get_is_narcissist_col">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_get_is_narcissist_col</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_get_is_narcissist_col" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests Dataset.get_is_narcissist_col().</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_get_sorted_columns">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_get_sorted_columns</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_get_sorted_columns" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests Dataset.get_sorted_column().</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_get_unique_column_values">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_get_unique_column_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_get_unique_column_values" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests Dataset.get_combined_anxiety_score().</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_incorrectly_load_Dataset_class">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_incorrectly_load_Dataset_class</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_incorrectly_load_Dataset_class" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_load_Dataset_class">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_load_Dataset_class</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_load_Dataset_class" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests if the dataset is successfully loaded.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.test_preprocessed_dataframe">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">test_preprocessed_dataframe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_dataset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_dataset.test_preprocessed_dataframe" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that the dataframe is preprocessed correctly.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_dataset.the_dataset">
+<span class="sig-prename descclassname"><span class="pre">src.test_dataset.</span></span><span class="sig-name descname"><span class="pre">the_dataset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></span><a class="headerlink" href="#src.test_dataset.the_dataset" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the initialised Dataset instance as a fixture.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>the initialised Dataset.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset">Dataset</a></p>
+</dd>
+</dl>
+</dd></dl>
+
+</section>
+<section id="module-src.test_plotter">
+<span id="src-test-plotter-module"></span><h2>src.test_plotter module<a class="headerlink" href="#module-src.test_plotter" title="Permalink to this heading">¶</a></h2>
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_catch_colname_not_in_df">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_catch_colname_not_in_df</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_plotter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Plotter.Plotter" title="src.Plotter.Plotter"><span class="pre">Plotter</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_catch_colname_not_in_df" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that functions that take colname correctly
+catch colnames not in dataset.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_catch_plotter_init_not_Dataset">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_catch_plotter_init_not_Dataset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_catch_plotter_init_not_Dataset" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that the Plotter’s init actually takes a src.Dataset.Dataset.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_catch_styling_params_not_dict">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_catch_styling_params_not_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_plotter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Plotter.Plotter" title="src.Plotter.Plotter"><span class="pre">Plotter</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">param</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_catch_styling_params_not_dict" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that functions that take styling_params correctly
+catch non dictionaries.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_catch_target_not_string">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_catch_target_not_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_plotter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Plotter.Plotter" title="src.Plotter.Plotter"><span class="pre">Plotter</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_catch_target_not_string" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that functions that take target correctly
+catch non strings.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_customize_plot">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_customize_plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_plotter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Plotter.Plotter" title="src.Plotter.Plotter"><span class="pre">Plotter</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_customize_plot" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_distribution_plot">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_distribution_plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_plotter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Plotter.Plotter" title="src.Plotter.Plotter"><span class="pre">Plotter</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_distribution_plot" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_load_plotter">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_load_plotter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_load_plotter" title="Permalink to this definition">¶</a></dt>
+<dd><p>Tests that the Plotter class can be loaded.</p>
+</dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_plot_categorical_bar_chart">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_plot_categorical_bar_chart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_plotter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Plotter.Plotter" title="src.Plotter.Plotter"><span class="pre">Plotter</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_plot_categorical_bar_chart" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_plot_categorical_boxplot">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_plot_categorical_boxplot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_plotter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Plotter.Plotter" title="src.Plotter.Plotter"><span class="pre">Plotter</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_plot_categorical_boxplot" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_plot_categorical_histplot">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_plot_categorical_histplot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_plotter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Plotter.Plotter" title="src.Plotter.Plotter"><span class="pre">Plotter</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_plot_categorical_histplot" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.test_plot_scatterplot">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">test_plot_scatterplot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">the_plotter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#src.Plotter.Plotter" title="src.Plotter.Plotter"><span class="pre">Plotter</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#src.test_plotter.test_plot_scatterplot" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py function">
+<dt class="sig sig-object py" id="src.test_plotter.the_plotter">
+<span class="sig-prename descclassname"><span class="pre">src.test_plotter.</span></span><span class="sig-name descname"><span class="pre">the_plotter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#src.Dataset.Dataset" title="src.Dataset.Dataset"><span class="pre">Dataset</span></a></span></span><a class="headerlink" href="#src.test_plotter.the_plotter" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</section>
+<section id="module-src">
+<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-src" title="Permalink to this heading">¶</a></h2>
+</section>
+</section>
+
+
+ </div>
+
+ </div>
+ </div>
+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebarwrapper">
+<h1 class="logo"><a href="../index.html">asdsd</a></h1>
+
+
+
+
+
+
+
+
+<h3>Navigation</h3>
+
+<div class="relations">
+<h3>Related Topics</h3>
+<ul>
+ <li><a href="../index.html">Documentation overview</a><ul>
+ </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+ <h3 id="searchlabel">Quick search</h3>
+ <div class="searchformwrapper">
+ <form class="search" action="../search.html" method="get">
+ <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+ <input type="submit" value="Go" />
+ </form>
+ </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div class="clearer"></div>
+ </div>
+ <div class="footer">
+ ©2023, asdasdasdadadasd.
+
+ |
+ Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a>
+ & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+
+ |
+ <a href="../_sources/source/src.rst.txt"
+ rel="nofollow">Page source</a>
+ </div>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000000000000000000000000000000000000..16220ff66f65d4d66ae9ec9bb98343d70db012f3
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "asdsd"
+copyright = "2023, asdasdasdadadasd"
+author = "asdasdasdadadasd"
+
+# The full version, including alpha/beta/rc tags
+release = "0.1"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ["sphinx.ext.napoleon", "sphinx.ext.autodoc"]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000000000000000000000000000000000000..5200b2a8daf733a7099445e62983b785da126a3d
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,20 @@
+.. asdsd documentation master file, created by
+ sphinx-quickstart on Fri Jul 14 02:13:49 2023.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to asdsd's documentation!
+=================================
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000000000000000000000000000000000000..8084272b4b7828a0748ae9209f92611e196801de
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.https://www.sphinx-doc.org/
+ exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
new file mode 100644
index 0000000000000000000000000000000000000000..e9ff8ac1a89c7bd18e69d633121f5a4022ac6fdf
--- /dev/null
+++ b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+src
+===
+
+.. toctree::
+ :maxdepth: 4
+
+ src
diff --git a/docs/source/src.rst b/docs/source/src.rst
new file mode 100644
index 0000000000000000000000000000000000000000..ba434d4ee44df3e898ed893fcd082ec4d4bf039b
--- /dev/null
+++ b/docs/source/src.rst
@@ -0,0 +1,45 @@
+src package
+===========
+
+Submodules
+----------
+
+src.Dataset module
+------------------
+
+.. automodule:: src.Dataset
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.Plotter module
+------------------
+
+.. automodule:: src.Plotter
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.test\_dataset module
+------------------------
+
+.. automodule:: src.test_dataset
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+src.test\_plotter module
+------------------------
+
+.. automodule:: src.test_plotter
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: src
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/src/Dataset.py b/src/Dataset.py
index 6d2b92ad1ce2dc9da9693ed9305b28952763325f..6fee9ca63176eea2a927b3aa2837969113fff354 100644
--- a/src/Dataset.py
+++ b/src/Dataset.py
@@ -187,7 +187,7 @@ class Dataset:
"""Get the combined anxiety score, as a column.
This score is based on the GAN, SPIN and SWL metrics.
Each of the three columns are first normalised,
- then the mean is returned.
+ then the mean is returned.
Args:
dataframe (pd.DataFrame): the dataframe.
diff --git a/src/test_dataset.py b/src/test_dataset.py
index 87d66df7520e34c29d51cdab50eecfe5d1580823..1fd58533632e835a00bce18b185b4f0e0402bb94 100644
--- a/src/test_dataset.py
+++ b/src/test_dataset.py
@@ -13,6 +13,11 @@ this_file_dir = Path(__file__).parent
@pytest.fixture
def the_dataset() -> Dataset:
+ """Returns the initialised Dataset instance as a fixture.
+
+ Returns:
+ Dataset: the initialised Dataset.
+ """
dataset = Dataset(str(this_file_dir / "../data/GamingStudy_data.csv"))
return dataset
diff --git a/test_package.egg-info/PKG-INFO b/test_package.egg-info/PKG-INFO
new file mode 100644
index 0000000000000000000000000000000000000000..37383ebe0c307bc871a88a48a1266add86d9f224
--- /dev/null
+++ b/test_package.egg-info/PKG-INFO
@@ -0,0 +1,5 @@
+Metadata-Version: 2.1
+Name: test-package
+Version: 0.1.0
+Author: me
+License-File: LICENSE.txt
diff --git a/test_package.egg-info/SOURCES.txt b/test_package.egg-info/SOURCES.txt
new file mode 100644
index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391
diff --git a/test_package.egg-info/dependency_links.txt b/test_package.egg-info/dependency_links.txt
new file mode 100644
index 0000000000000000000000000000000000000000..8b137891791fe96927ad78e64b0aad7bded08bdc
--- /dev/null
+++ b/test_package.egg-info/dependency_links.txt
@@ -0,0 +1 @@
+
diff --git a/test_package.egg-info/requires.txt b/test_package.egg-info/requires.txt
new file mode 100644
index 0000000000000000000000000000000000000000..6a5762e5ea584bf1cc858eecbfc362cc3701bdb4
--- /dev/null
+++ b/test_package.egg-info/requires.txt
@@ -0,0 +1,3 @@
+matplotlib
+pandas
+pytest
diff --git a/test_package.egg-info/top_level.txt b/test_package.egg-info/top_level.txt
new file mode 100644
index 0000000000000000000000000000000000000000..59c251e2851b438282268d754df59aae8d93cebb
--- /dev/null
+++ b/test_package.egg-info/top_level.txt
@@ -0,0 +1 @@
+test-package