Add light docs

pull/103/head
JulioV 2020-11-05 20:56:11 -05:00
parent 6f0e0d0791
commit fd67d54e09
2 changed files with 51 additions and 6 deletions

View File

@ -0,0 +1,44 @@
# Phone Light
Sensor parameters description for `[PHONE_LIGHT]`:
|Key                              | Description |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------
|`[TABLE]`| Database table where the light data is stored
## RAPIDS provider
!!! info "Available day segments and platforms"
- Available for all day segments
- Available for Android only
!!! info "File Sequence"
```bash
- data/raw/{pid}/phone_light_raw.csv
- data/raw/{pid}/phone_light_with_datetime.csv
- data/interim/{pid}/phone_light_features/phone_light_{language}_{provider_key}.csv
- data/processed/features/{pid}/phone_light.csv
```
Parameters description for `[PHONE_LIGHT][PROVIDERS][RAPIDS]`:
|Key                              | Description |
|----------------|-----------------------------------------------------------------------------------------------------------------------------------
|`[COMPUTE]`| Set to `True` to extract `PHONE_LIGHT` features from the `RAPIDS` provider|
|`[FEATURES]` | Features to be computed, see table below
Features description for `[PHONE_LIGHT][PROVIDERS][RAPIDS]`:
|Feature |Units |Description|
|-------------------------- |---------- |---------------------------|
|count |rows | Number light sensor rows recorded.
|maxlux |lux | The maximum ambient luminance.
|minlux |lux | The minimum ambient luminance.
|avglux |lux | The average ambient luminance.
|medianlux |lux | The median ambient luminance.
|stdlux |lux | The standard deviation of ambient luminance.
!!! note "Assumptions/Observations"
NA

View File

@ -65,14 +65,15 @@ nav:
- Introduction: features/feature-introduction.md
- Phone:
- Phone Data Quality: features/phone-data-quality.md
- Phone Messages: features/phone-messages.md
- Phone Calls: features/phone-calls.md
- Phone Bluetooth: features/phone-bluetooth.md
- Phone WiFI Visible: features/phone-wifi-visible.md
- Phone WiFI Connected: features/phone-wifi-connected.md
- Phone Accelerometer: features/phone-accelerometer.md
- Phone Activity Recognition: features/phone-activity-recognition.md
- Phone Applications Foreground: features/phone-applications-foreground.md
- Phone Battery: features/phone-battery.md
- Phone Activity Recognition: features/phone-activity-recognition.md
- Phone Bluetooth: features/phone-bluetooth.md
- Phone Calls: features/phone-calls.md
- Phone Light: features/phone-light.md
- Phone Messages: features/phone-messages.md
- Phone WiFI Connected: features/phone-wifi-connected.md
- Phone WiFI Visible: features/phone-wifi-visible.md
- Frequently Asked Questions: faq.md
- Citation: citation.md