Skip to content

Commit

Permalink
deploy: 8efeac7
Browse files Browse the repository at this point in the history
  • Loading branch information
@hagenw
hagenw committed Sep 5, 2024
0 parents commit 645f9c6
Show file tree
Hide file tree
Showing 128 changed files with 26,132 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -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: 473ff648b51ca45ddb6aa3fdb0180e6a
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/api/audpsychometric.agreement_categorical.doctree
Binary file not shown.
Binary file added .doctrees/api/audpsychometric.agreement_numerical.doctree
Binary file not shown.
Binary file added .doctrees/api/audpsychometric.congeneric_reliability.doctree
Binary file not shown.
Binary file added .doctrees/api/audpsychometric.cronbachs_alpha.doctree
Binary file not shown.
Binary file added .doctrees/api/audpsychometric.doctree
Binary file not shown.
Binary file added .doctrees/api/audpsychometric.evaluator_weighted_estimator.doctree
Binary file not shown.
Binary file added .doctrees/api/audpsychometric.intra_class_correlation.doctree
Binary file not shown.
Binary file added .doctrees/api/audpsychometric.list_datasets.doctree
Binary file not shown.
Binary file added .doctrees/api/audpsychometric.mode.doctree
Binary file not shown.
Binary file added .doctrees/api/audpsychometric.rater_agreement.doctree
Binary file not shown.
Binary file added .doctrees/api/audpsychometric.read_dataset.doctree
Binary file not shown.
Binary file added .doctrees/bibliography.doctree
Binary file not shown.
Binary file added .doctrees/changelog.doctree
Binary file not shown.
Binary file added .doctrees/contributing.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/genindex.doctree
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/installation.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
290 changes: 290 additions & 0 deletions _modules/audpsychometric/core/datasets.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,290 @@


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>audpsychometric.core.datasets &mdash; Documentation</title>




<link rel="shortcut icon" href="../../../_static/favicon.png"/>











<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/css/audeering.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />




<script src="../../../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav">


<div class="wy-grid-for-nav">


<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">


<a href="../../../index.html">

<img src="../../../_static/images/audeering.png" class="logo" alt="audEERING"/>


<span> audpsychometric</span>

</a>




<div class="version">
v0.1.0
</div>




<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>


</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../api/audpsychometric.html">audpsychometric</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../genindex.html">Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../bibliography.html">Bibliography</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../changelog.html">Changelog</a></li>
</ul>



</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../index.html">audpsychometric</a>

</nav>


<div class="wy-nav-content">

<div class="rst-content">

<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="../../index.html">Module code</a> &raquo;</li>
<li>audpsychometric.core.datasets</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>Source code for audpsychometric.core.datasets</h1><div class="highlight"><pre>
<span></span><span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;read_dataset&quot;</span><span class="p">,</span> <span class="s2">&quot;list_dataset&quot;</span><span class="p">]</span>

<span class="kn">import</span> <span class="nn">os</span>

<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>


<span class="n">data_directory</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
<span class="n">dataset_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">data_directory</span><span class="p">,</span> <span class="s2">&quot;datasets.csv&quot;</span><span class="p">)</span>
<span class="n">data_sets</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">dataset_path</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s2">&quot;,&quot;</span><span class="p">)</span>


<div class="viewcode-block" id="read_dataset"><a class="viewcode-back" href="../../../api/audpsychometric.read_dataset.html#audpsychometric.read_dataset">[docs]</a><span class="k">def</span> <span class="nf">read_dataset</span><span class="p">(</span><span class="n">data_set_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;Read dataset identified by name.</span>

<span class="sd"> retrieves a test dataset from within the package.</span>

<span class="sd"> Args:</span>
<span class="sd"> data_set_name(str): dataset name</span>

<span class="sd"> Returns:</span>
<span class="sd"> dataframe containing dataset</span>

<span class="sd"> Examples:</span>
<span class="sd"> &gt;&gt;&gt; df = read_dataset(&quot;wine&quot;)</span>
<span class="sd"> &gt;&gt;&gt; df.head()</span>
<span class="sd"> Wine Judge Scores</span>
<span class="sd"> 0 1 A 1</span>
<span class="sd"> 1 2 A 1</span>
<span class="sd"> 2 3 A 3</span>
<span class="sd"> 3 4 A 6</span>
<span class="sd"> 4 5 A 6</span>

<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">ds</span> <span class="o">=</span> <span class="n">data_sets</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="n">data_sets</span><span class="p">[</span><span class="s2">&quot;dataset&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="n">data_set_name</span><span class="p">]</span>

<span class="n">fname</span> <span class="o">=</span> <span class="n">ds</span><span class="p">[</span><span class="s2">&quot;fname&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">values</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">fpath</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">data_directory</span><span class="p">,</span> <span class="n">fname</span><span class="p">)</span>
<span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">fpath</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s2">&quot;,&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">df</span></div>


<div class="viewcode-block" id="list_datasets"><a class="viewcode-back" href="../../../api/audpsychometric.list_datasets.html#audpsychometric.list_datasets">[docs]</a><span class="k">def</span> <span class="nf">list_datasets</span><span class="p">():</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;List tests datasets available in package.</span>

<span class="sd"> Returns:</span>
<span class="sd"> dataframe listing available datasets</span>

<span class="sd"> Examples:</span>
<span class="sd"> &gt;&gt;&gt; list_datasets()</span>
<span class="sd"> fname ... description</span>
<span class="sd"> dataset ...</span>
<span class="sd"> statology statology.csv ... icc sample from web page</span>
<span class="sd"> hallgren-table5 Hallgren-Table-05.csv ... icc table from publication</span>
<span class="sd"> hallgren-table3 Hallgren-Table-03.csv ... kappa table from publication</span>
<span class="sd"> HolzingerSwineford1939 HolzingerSwineford1939.csv ... lavaan</span>
<span class="sd"> Shrout_Fleiss Shrout_Fleiss_1979.csv ... Dataset from paper</span>
<span class="sd"> wine wine.csv ... online source</span>
<span class="sd"> &lt;BLANKLINE&gt;</span>
<span class="sd"> [6 rows x 4 columns]</span>

<span class="sd"> &quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="n">df_data_sets</span> <span class="o">=</span> <span class="n">data_sets</span><span class="o">.</span><span class="n">set_index</span><span class="p">(</span><span class="s2">&quot;dataset&quot;</span><span class="p">)</span>
<span class="k">return</span> <span class="n">df_data_sets</span></div>
</pre></div>

</div>

</div>
<footer>


<hr/>

<div>








<ul>
<li><a href="http://data.pp.audeering.com">Data</a></li>
<li><a href="http://devops.pp.audeering.com/sphinx/">Docs</a></li>
<li><a href="http://devops.pp.audeering.com/">Infra</a></li>
<li><a href="http://models.pp.audeering.com">Models</a></li>
<li><a href="http://research.pp.audeering.com">Research</a></li>
<li><a href="http://tools.pp.audeering.com">Tools</a></li>
</ul>

<p>



Built with <a href="https://www.sphinx-doc.org">Sphinx</a> on 2024/09/05 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>

<div role="contentinfo">
<p>

&copy; audEERING GmbH
</p>
</div>

</footer>
</div>
</div>

</section>

</div>





<!--[if lt IE 9]>
<script src="../../../_static/js/html5shiv.min.js"></script>
<![endif]-->




<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/sphinx_highlight.js"></script>
<script src="../../../_static/clipboard.min.js"></script>
<script src="../../../_static/copybutton.js"></script>




<script type="text/javascript" src="../../../_static/js/theme.js"></script>

<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit 645f9c6

Please sign in to comment.