rapids/docs/usage/quick_rule.rst

43 lines
1.4 KiB
ReStructuredText
Raw Normal View History

2020-05-28 22:40:29 +02:00
.. _minimal-working-example:
2020-03-10 17:32:16 +01:00
Minimal Working Example
2020-06-25 22:32:45 +02:00
========================
2020-03-09 22:07:51 +01:00
This is a quick guide for creating and running a simple pipeline to extract call features for daily and night epochs of one participant monitored on the US East coast.
2020-03-09 22:07:51 +01:00
2020-03-10 17:27:27 +01:00
#. Make sure your database connection credentials in ``.env`` are correct. See step 1 of :ref:`Usage Section <db-configuration>`.
2020-03-09 22:07:51 +01:00
2020-03-10 17:27:27 +01:00
#. Create at least one participant file ``p01`` under ``data/external/``. See step 2 of :ref:`Usage Section <db-configuration>`.
2020-03-09 22:07:51 +01:00
2020-03-10 17:32:16 +01:00
#. Make sure your Conda (python) environment is active. See step 6 of :ref:`install-page`.
2020-03-09 22:07:51 +01:00
2020-03-10 17:27:27 +01:00
#. Modify the following settings in the ``config.yaml`` file with the values shown below (leave all other settings as they are)
2020-03-09 22:07:51 +01:00
2020-06-25 22:32:45 +02:00
::
PIDS: [p01]
DAY_SEGMENTS: &day_segments
[daily, night]
TIMEZONE: &timezone
America/New_York
DATABASE_GROUP: &database_group
MY_GROUP (change this if you added your DB credentials to .env with a different label)
CALLS:
COMPUTE: True
DB_TABLE: calls (only change DB_TABLE if your database calls table has a different name)
2020-03-09 22:07:51 +01:00
2020-06-25 22:32:45 +02:00
For more information on the ``calls`` sensor see :ref:`call-sensor-doc`
2020-03-09 22:07:51 +01:00
2020-03-10 17:27:27 +01:00
#. Run the following command to execute RAPIDS
2020-03-09 22:07:51 +01:00
::
2020-05-15 01:43:58 +02:00
snakemake -j1
2020-03-09 22:07:51 +01:00
2020-03-10 17:27:27 +01:00
#. Daily and night call metrics will be found in files under the ``data/processed/p01/`` directory.
2020-03-09 22:07:51 +01:00