rapids/docs/change-log.md

# Change Log

## v1.0.0
- Add a new [Overview](../setup/overview/) page.
- You can [extend](../datastreams/add-new-data-streams/) RAPIDS with your own [data streams](../datastreams/data-streams-introduction/). Data streams are data collected with other sensing apps besides AWARE (like Beiwe, mindLAMP), and stored in other data containers (databases, files) besides MySQL.
- Support to analyze Empatica wearable data (thanks to Joe Kim and  Brinnae Bent from the [DBDP](https://dbdp.org/))
- Support to analyze AWARE data stored in [CSV files](../datastreams/aware-csv/) and [InfluxDB](../datastreams/aware-influxdb/) databases
- Support to analyze data collected over [multiple time zones](../setup/configuration/#multiple-timezones)
- Support for [sleep intraday features](../features/fitbit-sleep-intraday/) from the core team and also from the community (thanks to Stephen Price)
- Users can comment on the documentation (powered by utterances).
- `SCR_SCRIPT` and `SRC_LANGUAGE` are replaced by `SRC_SCRIPT`.
- Add RAPIDS new logo
- Move Citation and Minimal Example page to the Setup section
- Add `config.yaml` validation schema and documentation. Now it's more difficult to modify the `config.yaml` file with invalid values.
- Add new `time at home` Doryab location feature
- Add and home coordinates to the location data file so location providers can build features based on it.
- If you are migrating from RAPIDS 0.4.3 or older, check this [guide](../migrating-from-old-versions/#migrating-from-rapids-04x-or-older)
## v0.4.3
- Fix bug when any of the rows from any sensor do not belong a time segment
## v0.4.2
- Update battery testing
- Fix location processing bug when certain columns don't exist
- Fix HR intraday bug when minutesonZONE features were 0 
- Update FAQs
- Fix HR summary bug when restinghr=0 (ignore those rows)
- Fix ROG, location entropy and normalized entropy in Doryab location provider
- Remove sampling frequency dependance in Doryab location provider
- Update documentation of Doryab location provider
- Add new `FITBIT_DATA_YIELD` `RAPIDS` provider
- Deprecate Doryab circadian movement feature until it is fixed
## v0.4.1
- Fix bug when no error message was displayed for an empty `[PHONE_DATA_YIELD][SENSORS]` when resampling location data
## v0.4.0
- Add four new phone sensors that can be used for PHONE_DATA_YIELD
- Add code so new feature providers can be added for the new four sensors
- Add new clustering algorithm (OPTICS) for Doryab features
- Update default EPS parameter for Doryab location clustering
- Add clearer error message for invalid phone data yield sensors
- Add ALL_RESAMPLED flag and accuracy limit for location features
- Add FAQ about null characters in phone tables
- Reactivate light and wifi tests and update testing docs
- Fix bug when parsing Fitbit steps data
- Fix bugs when merging features from empty time segments
- Fix minor issues in the documentation
## v0.3.2
- Update docker and linux instructions to use RSPM binary repo for for faster installation
- Update CI to create a release on a tagged push that passes the tests
- Clarify in DB credential configuration that we only support MySQL
- Add Windows installation instructions
- Fix bugs in the create_participants_file script
- Fix bugs in Fitbit data parsing.
- Fixed Doryab location features context of clustering.
- Fixed the wrong shifting while calculating distance in Doryab location features.
- Refactored the haversine function
## v0.3.1
- Update installation docs for RAPIDS' docker container
- Fix example analysis use of accelerometer data in a plot
- Update FAQ
- Update minimal example documentation
- Minor doc updates
## v0.3.0
- Update R and Python virtual environments
- Add GH actions CI support for tests and docker
- Add release and test badges to README
## v0.2.6
- Fix old versions banner on nested pages
## v0.2.5
- Fix docs deploy typo
## v0.2.4
- Fix broken links in landing page and docs deploy
## v0.2.3
- Fix participant IDS in the example analysis workflow
## v0.2.2
- Fix readme link to docs
## v0.2.1
- FIx link to the most recent version in the old version banner

## v0.2.0
- Add new `PHONE_BLUETOOTH` `DORYAB` provider
- Deprecate `PHONE_BLUETOOTH` `RAPIDS` provider
- Fix bug in `filter_data_by_segment` for Python when dataset was empty
- Minor doc updates
- New FAQ item

## v0.1.0
- New and more consistent docs (this website). The [previous docs](https://rapidspitt.readthedocs.io/en/latest/) are marked as beta 
- Consolidate [configuration](../setup/configuration) instructions
- Flexible [time segments](../setup/configuration#time-segments)
- Simplify Fitbit behavioral feature extraction and [documentation](../features/fitbit-heartrate-summary)
- Sensor's configuration and output is more consistent
- Update [visualizations](../visualizations/data-quality-visualizations) to handle flexible day segments
- Create a RAPIDS [execution](../setup/execution) script that allows re-computation of the pipeline after configuration changes
- Add [citation](../citation) guide
- Update [virtual environment](../developers/virtual-environments) guide
- Update analysis workflow [example](../workflow-examples/analysis)
- Add a [Code of Conduct](../code_of_conduct)
- Update [Team](../team) page
Add change log to docs 2020-12-04 22:21:22 +01:00			`# Change Log`
Update virtual envs 2020-12-18 20:06:28 +01:00
Update change log and migration guide 2021-03-12 22:28:20 +01:00			`## v1.0.0`
Update docs 2021-03-14 16:40:04 +01:00			`- Add a new [Overview](../setup/overview/) page.`
Update change log and migration guide 2021-03-12 22:28:20 +01:00			`- You can [extend](../datastreams/add-new-data-streams/) RAPIDS with your own [data streams](../datastreams/data-streams-introduction/). Data streams are data collected with other sensing apps besides AWARE (like Beiwe, mindLAMP), and stored in other data containers (databases, files) besides MySQL.`
			`- Support to analyze Empatica wearable data (thanks to Joe Kim and Brinnae Bent from the [DBDP](https://dbdp.org/))`
Add utterances comments 2021-03-14 21:13:18 +01:00			`- Support to analyze AWARE data stored in [CSV files](../datastreams/aware-csv/) and [InfluxDB](../datastreams/aware-influxdb/) databases`
Update change log and migration guide 2021-03-12 22:28:20 +01:00			`- Support to analyze data collected over [multiple time zones](../setup/configuration/#multiple-timezones)`
			`- Support for [sleep intraday features](../features/fitbit-sleep-intraday/) from the core team and also from the community (thanks to Stephen Price)`
Add utterances comments 2021-03-14 21:13:18 +01:00			`- Users can comment on the documentation (powered by utterances).`
Replace SRC LANGUAGE and FOLDER with SCRIPT 2021-03-15 00:52:14 +01:00			- `SCR_SCRIPT` and `SRC_LANGUAGE` are replaced by `SRC_SCRIPT`.
Update change log and migration guide 2021-03-12 22:28:20 +01:00			`- Add RAPIDS new logo`
			`- Move Citation and Minimal Example page to the Setup section`
			- Add `config.yaml` validation schema and documentation. Now it's more difficult to modify the `config.yaml` file with invalid values.
			- Add new `time at home` Doryab location feature
			`- Add and home coordinates to the location data file so location providers can build features based on it.`
			`- If you are migrating from RAPIDS 0.4.3 or older, check this [guide](../migrating-from-old-versions/#migrating-from-rapids-04x-or-older)`
Fix bug when any of the rows from any sensor do not belong a time segment 2021-02-09 20:51:54 +01:00			`## v0.4.3`
			`- Fix bug when any of the rows from any sensor do not belong a time segment`
Update change log for v0.4.2 so far 2021-02-02 18:05:01 +01:00			`## v0.4.2`
			`- Update battery testing`
			`- Fix location processing bug when certain columns don't exist`
			`- Fix HR intraday bug when minutesonZONE features were 0`
			`- Update FAQs`
			`- Fix HR summary bug when restinghr=0 (ignore those rows)`
			`- Fix ROG, location entropy and normalized entropy in Doryab location provider`
			`- Remove sampling frequency dependance in Doryab location provider`
			`- Update documentation of Doryab location provider`
Add new `FITBIT_DATA_YIELD` `RAPIDS` provider 2021-02-03 00:30:21 +01:00			- Add new `FITBIT_DATA_YIELD` `RAPIDS` provider
Deprecate Doryab circadian movement feature until it is fixed 2021-02-03 15:46:29 +01:00			`- Deprecate Doryab circadian movement feature until it is fixed`
Fix bug when no error message was displayed for an empty `[PHONE_DATA_YIELD][SENSORS]` when resampling location data 2021-01-27 23:12:53 +01:00			`## v0.4.1`
			- Fix bug when no error message was displayed for an empty `[PHONE_DATA_YIELD][SENSORS]` when resampling location data
Update change log for v0.4.0 2021-01-26 19:40:45 +01:00			`## v0.4.0`
Add code so new feature providers can be added for the new four sensors 2021-01-14 01:05:36 +01:00			`- Add four new phone sensors that can be used for PHONE_DATA_YIELD`
			`- Add code so new feature providers can be added for the new four sensors`
Update change log for v0.4.0 2021-01-26 19:40:45 +01:00			`- Add new clustering algorithm (OPTICS) for Doryab features`
			`- Update default EPS parameter for Doryab location clustering`
			`- Add clearer error message for invalid phone data yield sensors`
			`- Add ALL_RESAMPLED flag and accuracy limit for location features`
			`- Add FAQ about null characters in phone tables`
			`- Reactivate light and wifi tests and update testing docs`
			`- Fix bug when parsing Fitbit steps data`
			`- Fix bugs when merging features from empty time segments`
			`- Fix minor issues in the documentation`
Modified change log 2021-01-07 22:27:29 +01:00			`## v0.3.2`
Update changelog 2021-01-06 00:37:21 +01:00			`- Update docker and linux instructions to use RSPM binary repo for for faster installation`
			`- Update CI to create a release on a tagged push that passes the tests`
			`- Clarify in DB credential configuration that we only support MySQL`
			`- Add Windows installation instructions`
Fix bugs in Fitbit data parsing - Fix the script that was breaking with an empty file - Fix the script that was breaking when start/end dates were empty - Ambigous and nonexistent DST times are handled now - Remove unnecessary else clause 2021-01-06 17:43:01 +01:00			`- Fix bugs in the create_participants_file script`
			`- Fix bugs in Fitbit data parsing.`
Modified change log 2021-01-07 22:27:29 +01:00			`- Fixed Doryab location features context of clustering.`
			`- Fixed the wrong shifting while calculating distance in Doryab location features.`
			`- Refactored the haversine function`
v0.3.1 2020-12-21 22:30:46 +01:00			`## v0.3.1`
			`- Update installation docs for RAPIDS' docker container`
			`- Fix example analysis use of accelerometer data in a plot`
			`- Update FAQ`
			`- Update minimal example documentation`
			`- Minor doc updates`
			`## v0.3.0`
Update virtual envs 2020-12-18 20:06:28 +01:00			`- Update R and Python virtual environments`
- Update R and Python virtual environments - Add GH actions CI support for tests and docker - Add release and test badges to README 2020-12-21 00:35:54 +01:00			`- Add GH actions CI support for tests and docker`
			`- Add release and test badges to README`
Fix old versions banner on nested pages 2020-12-20 23:03:11 +01:00			`## v0.2.6`
			`- Fix old versions banner on nested pages`
Fix docs deploy typo 2020-12-19 04:46:30 +01:00			`## v0.2.5`
			`- Fix docs deploy typo`
Fix broken links in landing page and docs deploy 2020-12-19 04:35:10 +01:00			`## v0.2.4`
			`- Fix broken links in landing page and docs deploy`
Fix participant IDS in the example analysis workflow 2020-12-18 17:27:04 +01:00			`## v0.2.3`
			`- Fix participant IDS in the example analysis workflow`
Fix readme link to docs 2020-12-12 23:51:01 +01:00			`## v0.2.2`
			`- Fix readme link to docs`
Fix old version banner 2020-12-12 23:36:15 +01:00			`## v0.2.1`
			`- FIx link to the most recent version in the old version banner`

Fix BT doryab bug and update change log 2020-12-12 23:11:48 +01:00			`## v0.2.0`
			- Add new `PHONE_BLUETOOTH` `DORYAB` provider
			- Deprecate `PHONE_BLUETOOTH` `RAPIDS` provider
			- Fix bug in `filter_data_by_segment` for Python when dataset was empty
Update faq 2020-12-10 00:54:49 +01:00			`- Minor doc updates`
			`- New FAQ item`

Add change log to docs 2020-12-04 22:21:22 +01:00			`## v0.1.0`
			`- New and more consistent docs (this website). The [previous docs](https://rapidspitt.readthedocs.io/en/latest/) are marked as beta`
			`- Consolidate [configuration](../setup/configuration) instructions`
			`- Flexible [time segments](../setup/configuration#time-segments)`
			`- Simplify Fitbit behavioral feature extraction and [documentation](../features/fitbit-heartrate-summary)`
			`- Sensor's configuration and output is more consistent`
			`- Update [visualizations](../visualizations/data-quality-visualizations) to handle flexible day segments`
			`- Create a RAPIDS [execution](../setup/execution) script that allows re-computation of the pipeline after configuration changes`
			`- Add [citation](../citation) guide`
			`- Update [virtual environment](../developers/virtual-environments) guide`
			`- Update analysis workflow [example](../workflow-examples/analysis)`
			`- Add a [Code of Conduct](../code_of_conduct)`
			`- Update [Team](../team) page`