From b469735e9de0c41e1a261db399c3acef6a8a57e9 Mon Sep 17 00:00:00 2001 From: nleo575 <38141307+nleo575@users.noreply.github.com> Date: Fri, 6 Mar 2020 12:50:59 -0500 Subject: [PATCH] Fixed typos and clarified some of the language. --- docs/usage/introduction.rst | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/usage/introduction.rst b/docs/usage/introduction.rst index 22b77fe8..b54afb5e 100644 --- a/docs/usage/introduction.rst +++ b/docs/usage/introduction.rst @@ -1,38 +1,38 @@ Quick Introduction ================== -The goal of this pipeline is to standardize the data cleaning, featuring extraction, analysis, and evaluation of mobile sensing projects. It leverages Cookiecutter_, Snakemake_, Sphinx_, Scypy_, R_, and Conda_ to create an end-to-end reproducible environment that can be published along with research papers. +The goal of this pipeline is to standardize the data cleaning, featuring extraction, analysis, and evaluation of mobile sensing projects. It leverages Conda_, Cookiecutter_, SciPy_, Snakemake_, Sphinx_, and R_ to create an end-to-end reproducible environment that can be published along with research papers. -At the moment, mobile data can be collected using different sensing frameworks (AWARE_, Beiwe_) and hardware (Fitbit_). The pipeline is agnostic to these data sources and can unify their analysis. The current implementation only handles data collected with AWARE_. However, it should be easy to extend it to other providers. +At the moment, mobile data can be collected using different sensing frameworks (AWARE_, Beiwe_) and hardware (Fitbit_). The pipeline is agnostic to these data sources and can unify their analysis. The current implementation only handles data collected with AWARE_. However, it can be easily extended to other providers. -We recommend reading Snakemake_ docs, but the main idea behind the pipeline is that every link in the analysis chain is a rule with an input and an output. Input and output (generally) are files, and these files can be manipulated using any programming language (although Snakemake_ has wrappers for Python_, R_, and Julia_ that can make development slightly more comfortable). Snakemake_ also allows us to spread the execution of rules over multiple cores, which means that a single analysis pipeline can be executed in parallel for all participants in a study without any code changes. +We recommend reading Snakemake_ docs, but the main idea behind the pipeline is that every link in the analysis chain is a rule with an input and an output. Input and output (generally) are files, which can be manipulated using any programming language (although Snakemake_ has wrappers for Julia_, Python_, and R_ that can make development slightly more comfortable). Snakemake_ also allows the pipeline rules to be executed in parallel on multiple cores without any code changes. This can drastically reduce the time needed to complete complete an analysis. Available features: -- :ref:`sms-sensor-doc` -- :ref:`call-sensor-doc` -- :ref:`bluetooth-sensor-doc` -- :ref:`google-activity-recognition` -- :ref:`battery` -- :ref:`location-features` -- :ref:`screen` -- :ref:`light` - :ref:`accelerometer` - :ref:`applications_foreground` +- :ref:`battery` +- :ref:`bluetooth-sensor-doc` +- :ref:`call-sensor-doc` - :ref:`fitbit-heart-rate` - :ref:`fitbit-steps` - -Applications_foreground - -We are updating these docs constantly, but if you think something needs clarification, feel free to reach out or submit a pull request in GitHub. +- :ref:`google-activity-recognition` +- :ref:`light` +- :ref:`location-features` +- :ref:`screen` +- :ref:`sms-sensor-doc` +We are updating these docs constantly, but if you think something needs clarification, feel free to reach out or submit a pull request on GitHub. + + +.. _Conda: https://docs.conda.io/en/latest/ .. _Cookiecutter: http://drivendata.github.io/cookiecutter-data-science/ +.. _SciPy: https://www.scipy.org/index.html .. _Snakemake: https://snakemake.readthedocs.io/en/stable/ .. _Sphinx: https://www.sphinx-doc.org/en/master/ -.. _Scypy: https://www.scipy.org/index.html .. _R: https://www.r-project.org/ -.. _Conda: https://docs.conda.io/en/latest/ + .. _AWARE: https://awareframework.com/what-is-aware/ .. _Beiwe: https://www.beiwe.org/ .. _Fitbit: https://www.fitbit.com/us/home