Kailo-beewell-dashboard

**Release date:** 25th April 2024

**Contibutors:** Annalise Clelland

Test to add more details to markdown

Added
* Test sentence

**Release date:** 16th April 2024

**Contributors:** Ellen Goddard

Test making a change to package

Added
* Test sentence

**Release date:** 12th April 2024

**Contributors:** Amy Heather

Fixed generation of caution statement in static report for school dashboards.

Fixed

* Fixed generation of caution comparing statement (to refer to new function rather than old reference to dictionary) for the static reports in the school dashboards

**Release date:** 9th April 2024

**Contributors:** Amy Heather

Fixed package so that css and image files are included in dist.

Fixed

* Fixed so that css and image files are now included in package dist (as previously were excluded)

**Release date:** 9th April 2024

**Contributors:** Amy Heather

Modified package so it can be used to produce the **synthetic public** BeeWell survey dashboard, as well as the standard and symbol survey dashboards.

Added

* An introduction to and glossary for CSS to the package documentation
* Step-by-step on dashboard maintenace (updating to use new package version) in package documentation
* CSS stylesheets and image files
* `about_page.py` - to produce the About pages for each dashboard - with loads more text used in this added to to `reuse_text.py`
* Add `choose_topic()` to `explore_results.py` (although produced errors when used on public dashboard as the selectbox wouldn't update correctly between two pages that both used this function, so ended up producing those manually in script rather than using this function, which is now just used in processing)
* `map.py` - to produce map for public dashboard with results for standard survey by MSOA
* Add function for `get_image_path()`
* `topic_labels.py` - names and descriptions used for the standard survey topics

Changed

* Modified and added to some of the documentation pages (package maintenance, streamlit community cloud)
* Use CSS and image files stored within package rather than within dashboard directory (modifications throughout package), and import them with package in `setup.py`
* Renamed `convert_image.py` to `images.py`
* Seperated `create_and_aggregate_data.py` into four seperate scripts, with modifications and additions throughout that enable it to be used for creation and processing of data for the public dashboard -
* `synthesise_aggregate.py`
* `synthesise_demographic.py`
* `synthesise_responses.py`
* `synthesise_scores.py`
* Modified text of `write_response_section_intro()` and `caution_comparing()` so can be used for public dashboard
* Standard survey school dashboard no longer imports standard_school_aggregate_scores (and just the version with RAG added)
* In `extract_nested_results()`, made addition of group optional
* Changed how the RAG boxes are created in `summary_rag.py`
* Adapted `who_took_part.py` to work with public dashboard
* Modified environment in `requirements.txt`

**Release date:** 1st March 2024

**Contributors:** Amy Heather

Modified package so it can be used to produce the **synthetic symbol** BeeWell survey dashboard, as well as the standard survey dashboard.

Added

* Created `CHANGELOG.md` (with backdated entry for 0.1.0)
* Created `CITATION.cff`
* Created package documentation using Sphinx and readthedocs - `docs/` and `.readthedocs.yaml`
* `create_group_list()` in `bar_charts.py` which creates a correctly formatted list of strings depending on number of inputs (e.g. 'a', 'a and b', 'a, b and c')
* `grammar.py` - contains `lower_first()` which converts first letter of string to lower case, unless all other letters are upper case
* Add `aggregate_demographic()` to `create_and_aggregate_data.py`
* Add new alternative inputs, outputs and process to existing functions that were developed for standard survey, so they can be used to output equivalent content for symbol survey. This includes
* `authentication.py` - custom login screen text
* `create_and_aggregate_data.py` - two possible sets of groups to aggregate by
* `explore_results.py` - custom page text, and providing survey type to functions like `filter_by_group()`
* `import_data.py` - add names of data for symbol survey as for session_state and as in TiDB Cloud, and simplified import function
* `page_setup.py` - to use name 'symbol' survey in the page menu
* `reshape_data.py` - for differences with symbol (e.g. exc SEN)
* `response_labels.py` - new function `create_symbol_response_label_dict()`
* `static_report.py` - converting some of the processes into standalone functions, so they can be imported to old function making static standard report and new function making static symbol report
* `who_took_part.py` - modifications for symbol like different headers and no descriptive text

Changed

* Moved all About page text to `reuse_text.py`
* In `requirements.txt`, upgraded pip to 24.0 and streamlit to 1.31.1, and add packages used to produce documentation (sphinx, sphinx-rtd-theme, myst-parser, sphinx-autoapi)

Removed

* Removed option to compare data import from TiDB to imported CSVs from the project directory (as function wasn't being used) in `import_data.py`

Fixed

* Hide responses (and non-response) on 'who took part' if n<10 for a given response option (more strict than elsewhere on dashboard, which just requires n>=10 for the entire question). For this, modified `survey_responses()` in `bar_charts.py`