Rename configuration page

pull/103/head
JulioV 2020-12-02 17:27:05 -05:00
parent c24cba8679
commit f4aeb3bba9
6 changed files with 7 additions and 7 deletions

View File

@ -41,7 +41,7 @@ Parameters description for `[PHONE_LOCATIONS][PROVIDERS][BARNETT]`:
|`[COMPUTE]`| Set to `True` to extract `PHONE_LOCATIONS` features from the `BARNETT` provider| |`[COMPUTE]`| Set to `True` to extract `PHONE_LOCATIONS` features from the `BARNETT` provider|
|`[FEATURES]` | Features to be computed, see table below |`[FEATURES]` | Features to be computed, see table below
|`[ACCURACY_LIMIT]` | An integer in meters, any location rows with an accuracy higher than this will be dropped. This number means there's a 68% probability the true location is within this radius |`[ACCURACY_LIMIT]` | An integer in meters, any location rows with an accuracy higher than this will be dropped. This number means there's a 68% probability the true location is within this radius
|`[TIMEZONE]` | Timezone where the location data was collected. By default points to the one defined in the [Initial configuration](../../setup/configuration#timezone-of-your-study) |`[TIMEZONE]` | Timezone where the location data was collected. By default points to the one defined in the [Configuration](../../setup/configuration#timezone-of-your-study)
|`[MINUTES_DATA_USED]` | Set to `True` to include an extra column in the final location feature file containing the number of minutes used to compute the features on each day segment. Use this for quality control purposes, the more data minutes exist for a period, the more reliable its features should be. For fused location, a single minute can contain more than one coordinate pair if the participant is moving fast enough. |`[MINUTES_DATA_USED]` | Set to `True` to include an extra column in the final location feature file containing the number of minutes used to compute the features on each day segment. Use this for quality control purposes, the more data minutes exist for a period, the more reliable its features should be. For fused location, a single minute can contain more than one coordinate pair if the participant is moving fast enough.

View File

@ -1,7 +1,7 @@
# File Structure # File Structure
!!! tip !!! tip
Read this page if you want to learn more about how RAPIDS is structured. If you want to start using it go to [Installation](../setup/installation/) and then to [Initial Configuration](../setup/configuration/) Read this page if you want to learn more about how RAPIDS is structured. If you want to start using it go to [Installation](../setup/installation/), then to [Configuration](../setup/configuration/), and then to [Execution](../setup/execution/)
All paths mentioned in this page are relative to RAPIDS' root folder. All paths mentioned in this page are relative to RAPIDS' root folder.

View File

@ -13,7 +13,7 @@ RAPIDS is open source, documented, modular, tested, and reproducible. At the mom
:fontawesome-solid-tasks: Join our discussions on our algorithms and assumptions for feature [processing](https://github.com/carissalow/rapids/issues?q=is%3Aissue+is%3Aopen+label%3Adiscussion). :fontawesome-solid-tasks: Join our discussions on our algorithms and assumptions for feature [processing](https://github.com/carissalow/rapids/issues?q=is%3Aissue+is%3Aopen+label%3Adiscussion).
:fontawesome-solid-play: Ready to start? Go to [Installation](setup/installation/) and then to [Initial Configuration](setup/configuration/) :fontawesome-solid-play: Ready to start? Go to [Installation](setup/installation/), then to [Configuration](setup/configuration/), and then to [Execution](setup/execution/)
## How does it work? ## How does it work?

View File

@ -1,5 +1,5 @@
# Initial Configuration # Configuration
You need to follow these steps to configure your RAPIDS deployment before you can extract behavioral features You need to follow these steps to configure your RAPIDS deployment before you can extract behavioral features
@ -10,7 +10,7 @@ You need to follow these steps to configure your RAPIDS deployment before you ca
5. Modify your [device data source configuration](#device-data-source-configuration) 5. Modify your [device data source configuration](#device-data-source-configuration)
6. Select what [sensors and features](#sensor-and-features-to-process) you want to process 6. Select what [sensors and features](#sensor-and-features-to-process) you want to process
When you are done with this initial configuration, go to [executing RAPIDS](setup/execution). When you are done with this configuration, go to [executing RAPIDS](setup/execution).
!!! hint !!! hint
Every time you see `config["KEY"]` or `[KEY]` in these docs we are referring to the corresponding key in the `config.yaml` file. Every time you see `config["KEY"]` or `[KEY]` in these docs we are referring to the corresponding key in the `config.yaml` file.

View File

@ -4,7 +4,7 @@ Minimal Working Example
This is a quick guide for creating and running a simple pipeline to extract missing, outgoing, and incoming call features for `daily` and `night` epochs of one participant monitored on the US East coast. This is a quick guide for creating and running a simple pipeline to extract missing, outgoing, and incoming call features for `daily` and `night` epochs of one participant monitored on the US East coast.
1. Install RAPIDS and make sure your `conda` environment is active (see [Installation](../../setup/installation)) 1. Install RAPIDS and make sure your `conda` environment is active (see [Installation](../../setup/installation))
2. Make the changes listed below for the corresponding [Initial Configuration](../../setup/configuration) step (we provide an example of what the relevant sections in your `config.yml` will look like after you are done) 2. Make the changes listed below for the corresponding [Configuration](../../setup/configuration) step (we provide an example of what the relevant sections in your `config.yml` will look like after you are done)
!!! info "Things to change on each configuration step" !!! info "Things to change on each configuration step"
1\. Setup your database connection credentials in `.env`. We assume your credentials group is called `MY_GROUP`. 1\. Setup your database connection credentials in `.env`. We assume your credentials group is called `MY_GROUP`.

View File

@ -72,7 +72,7 @@ nav:
- Setup: - Setup:
- File Structure: file-structure.md - File Structure: file-structure.md
- Installation: 'setup/installation.md' - Installation: 'setup/installation.md'
- Initial Configuration: setup/configuration.md - Configuration: setup/configuration.md
- Execution: setup/execution.md - Execution: setup/execution.md
- Example Workflows: - Example Workflows:
- Minimal: workflow-examples/minimal.md - Minimal: workflow-examples/minimal.md