Deployed c33baa8
to dev with MkDocs 1.1.2 and mike 0.5.5
parent
e938765a70
commit
65de3ddffd
|
@ -1160,38 +1160,34 @@
|
|||
<p>The following is a simple guide to testing RAPIDS. All files necessary for testing are stored in the <code>/tests</code> directory</p>
|
||||
<h2 id="steps-for-testing">Steps for Testing<a class="headerlink" href="#steps-for-testing" title="Permanent link">¶</a></h2>
|
||||
<ol>
|
||||
<li>To begin testing RAPIDS place the fake raw input data <code>csv</code> files in
|
||||
<li>To begin testing RAPIDS place the fake raw input data <code>csv</code> files of each fake participant in
|
||||
<code>tests/data/raw/</code>. The fake participant files should be placed in
|
||||
<code>tests/data/external/</code>. The expected output files of RAPIDS after
|
||||
processing the input data should be placed in
|
||||
<code>tests/data/processesd/</code>.</li>
|
||||
<li>The Snakemake rule(s) that are to be tested must be placed in the
|
||||
<code>tests/Snakemake</code> file. The current <code>tests/Snakemake</code> is a good
|
||||
example of how to define them. (At the time of writing this
|
||||
documentation the snakefile contains rules messages (SMS), calls and
|
||||
screen)</li>
|
||||
<li>Edit the <code>tests/settings/config.yaml</code>. Add and/or remove the rules
|
||||
<code>tests/data/external/participant_files</code>. The expected output files of RAPIDS after
|
||||
processing the input data should be placed in <code>tests/data/processesd/frequency</code> and <code>tests/data/processesd/periodic</code> for frequency and periodic respectively.</li>
|
||||
<li>Edit <code>tests/settings/frequency/config.yaml</code> and <code>tests/settings/periodic/config.yaml</code> to add and/or remove the rules
|
||||
to be run for testing from the <code>forcerun</code> list.</li>
|
||||
<li>Edit the <code>tests/settings/testing_config.yaml</code> with the necessary
|
||||
configuration settings for running the rules to be tested.</li>
|
||||
<li>Edit <code>tests/settings/frequency/testing_config.yaml</code> and <code>tests/settings/frequency/testing_config.yaml</code> to configure the settings and enable/disable sensors to be tested.</li>
|
||||
<li>Add any additional testscripts in <code>tests/scripts</code>.</li>
|
||||
<li>Uncomment or comment off lines in the testing shell script
|
||||
<code>tests/scripts/run_tests.sh</code>.</li>
|
||||
<li>
|
||||
<p>Run the testing shell script.</p>
|
||||
<div class="highlight"><pre><span></span><code>tests/scripts/run_tests.sh
|
||||
<li>Run the testing shell script with
|
||||
<div class="highlight"><pre><span></span><code>tests/scripts/run_tests.sh
|
||||
run_test.sh <span class="o">[</span>-l<span class="o">]</span> <span class="o">[</span>all <span class="p">|</span> periodic <span class="p">|</span> frequency<span class="o">]</span> <span class="o">[</span>test<span class="o">]</span>
|
||||
</code></pre></div>
|
||||
</li>
|
||||
<code>[-l]</code> will delete all the existing files in <code>/data</code> before running tests.
|
||||
<code>[all | periodic | frequency]</code> will generate feature data for all or specific type of features and save in <code>data/processed</code>.
|
||||
<code>[test]</code> will compare the features generated with the precomputed and verified features in <code>/tests/data/processed</code>.</li>
|
||||
</ol>
|
||||
<p>The following is a snippet of the output you should see after running your test.</p>
|
||||
<div class="highlight"><pre><span></span><code>test_sensors_files_exist <span class="o">(</span>test_sensor_features.TestSensorFeatures<span class="o">)</span> ... ok
|
||||
test_sensors_features_calculations <span class="o">(</span>test_sensor_features.TestSensorFeatures<span class="o">)</span> ... <span class="nv">FAIL</span>
|
||||
<div class="highlight"><pre><span></span><code>test_sensors_files_exist <span class="o">(</span>test_sensor_features.TestSensorFeatures<span class="o">)</span> ... periodic
|
||||
ok
|
||||
test_sensors_features_calculations <span class="o">(</span>test_sensor_features.TestSensorFeatures<span class="o">)</span> ... periodic
|
||||
ok
|
||||
|
||||
<span class="o">======================================================================</span>
|
||||
FAIL: test_sensors_features_calculations <span class="o">(</span>test_sensor_features.TestSensorFeatures<span class="o">)</span>
|
||||
----------------------------------------------------------------------
|
||||
test_sensors_files_exist <span class="o">(</span>test_sensor_features.TestSensorFeatures<span class="o">)</span> ... frequency
|
||||
ok
|
||||
test_sensors_features_calculations <span class="o">(</span>test_sensor_features.TestSensorFeatures<span class="o">)</span> ... frequency
|
||||
FAIL
|
||||
</code></pre></div>
|
||||
<p>The results above show that the first test <code>test_sensors_files_exist</code> passed while <code>test_sensors_features_calculations</code> failed. In addition you should get the traceback of the failure (not shown here). For more information on how to implement test scripts and use unittest please see <a href="https://docs.python.org/3.7/library/unittest.html#command-line-interface">Unittest Documentation</a></p>
|
||||
<p>The results above show that the for periodic both <code>test_sensors_files_exist</code> and <code>test_sensors_features_calculations</code> passed while for frequency first test <code>test_sensors_files_exist</code> passed while <code>test_sensors_features_calculations</code> failed. In addition you should get the traceback of the failure (not shown here). For more information on how to implement test scripts and use unittest please see <a href="https://docs.python.org/3.7/library/unittest.html#command-line-interface">Unittest Documentation</a></p>
|
||||
<p>Testing of the RAPIDS sensors and features is a work-in-progress. Please see <code class="interpreted-text" role="ref">test-cases</code> for a list of sensors and features that have testing currently available.</p>
|
||||
<p>Currently the repository is set up to test a number of sensors out of the box by simply running the <code>tests/scripts/run_tests.sh</code> command once the RAPIDS python environment is active.</p>
|
||||
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -1,187 +1,187 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url><url>
|
||||
<loc>None</loc>
|
||||
<lastmod>2021-01-20</lastmod>
|
||||
<lastmod>2021-01-21</lastmod>
|
||||
<changefreq>daily</changefreq>
|
||||
</url>
|
||||
</urlset>
|
Binary file not shown.
Loading…
Reference in New Issue