junos
/
rapids
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update SMS docs

pull/95/head
JulioV 2020-05-28 17:35:37 -04:00
parent cbd7729457
commit a767258ee7
1 changed files with 8 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/features/extracted.rst
View File

@ -70,19 +70,11 @@ SMS
See `SMS Config Code`_ See `SMS Config Code`_
**Available Epochs:** **Available Epochs:** daily, morning, afternoon, evening, night
- daily **Available Platforms:** Android
- morning
- afternoon
- evening
- night
**Available Platforms:** **Snakefile entry to compute these features:**
- Android
**Snakefile Entry:**
.. - Download raw SMS dataset: ``expand("data/raw/{pid}/{sensor}_raw.csv", pid=config["PIDS"], sensor=config["SENSORS"]),`` .. - Download raw SMS dataset: ``expand("data/raw/{pid}/{sensor}_raw.csv", pid=config["PIDS"], sensor=config["SENSORS"]),``
@ -97,18 +89,9 @@ See `SMS Config Code`_
**Rule Chain:** **Rule Chain:**
- **Rule:** ``rules/preprocessing.snakefile/download_dataset`` - See the download_dataset_ rule. - Rule ``rules/preprocessing.snakefile/download_dataset``
- Rule ``rules/preprocessing.snakefile/readable_datetime``
- **Script:** ``src/data/download_dataset.R`` - See the download_dataset.R_ script. - Rule ``rules/features.snakefile/sms_features``
- **Rule:** ``rules/preprocessing.snakefile/readable_datetime`` - See the readable_datetime_ rule.
- **Script:** ``src/data/readable_datetime.R`` - See the readable_datetime.R_ script.
- **Rule:** ``rules/features.snakefile/sms_features`` - See the sms_features_ rule.
- **Script:** ``src/features/sms_features.R`` - See the sms_features.R_ script.
.. _sms-parameters: .. _sms-parameters:
@ -119,15 +102,13 @@ Name Description
============ =================== ============ ===================
sms_type The particular ``sms_type`` that will be analyzed. The options for this parameter are ``received`` or ``sent``. sms_type The particular ``sms_type`` that will be analyzed. The options for this parameter are ``received`` or ``sent``.
day_segment The particular ``day_segment`` that will be analyzed. The available options are ``daily``, ``morning``, ``afternoon``, ``evening``, ``night`` day_segment The particular ``day_segment`` that will be analyzed. The available options are ``daily``, ``morning``, ``afternoon``, ``evening``, ``night``
features The different measures that can be retrieved from the dataset. These features are available for both ``sent`` and ``received`` SMS messages. See :ref:`Available SMS Features <sms-available-features>` Table below features Features to be computed, see table below
============ =================== ============ ===================
.. _sms-available-features: .. _sms-available-features:
**Available SMS Featues** **Available SMS Featues**
The following table shows a list of the available featues for both ``sent`` and ``received`` SMS.
========================= ========= ============= ========================= ========= =============
Name Units Description Name Units Description
========================= ========= ============= ========================= ========= =============
@ -140,15 +121,13 @@ countmostfrequentcontact SMS The count of the number of ``SMS`` mes
**Assumptions/Observations:** **Assumptions/Observations:**
#. ``TYPES`` and ``FEATURES`` keys need to match. From example:: #. ``TYPES`` and ``FEATURES`` keys need to match. For example, in the config setting below the ``TYPE`` ``sent`` matches the ``FEATURES`` key ``sent``::
SMS: SMS:
TYPES: [sent] TYPES: [sent]
FEATURES: FEATURES:
sent: [count, distinctcontacts, timefirstsms, timelastsms, countmostfrequentcontact] sent: [count, distinctcontacts, timefirstsms, timelastsms, countmostfrequentcontact]
In the above config setting code the ``TYPE`` ``sent`` matches the ``FEATURES`` key ``sent``.
.. _call-sensor-doc: .. _call-sensor-doc: