From 3f95387d75362e66851fb09a8ae9ca31093a077c Mon Sep 17 00:00:00 2001
From: kaguillera <kaguillera@users.noreply.github.com>
Date: Mon, 9 Mar 2020 17:07:51 -0400
Subject: [PATCH] Added the Quick Rule Page

---
 docs/index.rst            |  1 +
 docs/usage/quick_rule.rst | 59 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+)
 create mode 100644 docs/usage/quick_rule.rst

diff --git a/docs/index.rst b/docs/index.rst
index 2d18ec61..64d0440c 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,6 +16,7 @@ Contents:
 
    usage/introduction
    usage/installation
+   usage/quick_rule
    usage/snakemake_docs
 
 .. toctree::
diff --git a/docs/usage/quick_rule.rst b/docs/usage/quick_rule.rst
new file mode 100644
index 00000000..7266949d
--- /dev/null
+++ b/docs/usage/quick_rule.rst
@@ -0,0 +1,59 @@
+Quick Rule 
+=============
+
+The following is a quick guide for creating and running a simple rule.
+
+#. Setup database connection credential the ``.env``. See step 1 under the :ref:`Usage Section of Install <db-configuration>` page.
+
+#. Create at least one participant file ``p01`` in the ``data/external``. See step 2 under the :ref:`Usage Section of Install <db-configuration>` page.
+
+#. Activate the Conda (python) environment. See install step 2 on :ref:`install-page` page.
+
+#. Prepare the ``Snakefile`` by replacing the code in the ``Snakefile`` with the following
+    
+    ::
+
+        configfile: "config.yaml"
+        include: "rules/packrat.snakefile"
+        include: "rules/preprocessing.snakefile"
+        include: "rules/features.snakefile"
+        include: "rules/reports.snakefile"
+
+        rule all:
+            input:
+                expand("data/processed/{pid}/call_{call_type}_{day_segment}.csv",
+                                pid=config["PIDS"], 
+                                call_type=config["CALLS"]["TYPES"],
+                                day_segment = config["CALLS"]["DAY_SEGMENTS"]),
+
+
+#. Prepare the ``config.yaml`` changing the following settings only to values shown below (leave all other settings as they are)
+
+    ::
+
+        SENSORS: [calls]
+
+        FITBIT_TABLE: []
+        FITBIT_SENSORS: []
+
+        PIDS: [p01]
+        
+        DAY_SEGMENTS: &day_segments
+            [daily, night]
+
+        TIMEZONE: &timezone
+            America/New_York
+        
+        DATABASE_GROUP: &database_group
+            MY_GROUP
+    
+    For more information on the ``calls`` sensor see :ref:`call-sensor-doc`
+
+#. Run the following command to execute the rule
+
+    ::
+
+        snakemake
+
+#. The results of the execution of the rule will be found in the ``data/processed/p01`` directory.
+