Prepare v0.1.0

[behackl]

This PR contains all pre-release preparations.

• Add information to documentation about where to find changelogs
• Prepare changelog

---

GitHub-generated changelog:

What's Changed

Breaking Changes

• Refactor find_CC_periods to return IntervalLabel by @sorlob in refactor find_CC_periods to return IntervalLabel #164
• Add auxiliary data structure DataSlice holding the output of Channel.get_data / Label.get_data by @behackl in Add auxiliary data structure DataSlice holding the output of Channel.get_data / Label.get_data #184

New Features / Enhancements

• Add method for truncating Vitals, Channel, Label by @behackl in Add method for truncating Vitals, Channel, Label #21
• Feature: plot IntervalLabel as filled background regions when they don't hold y-data by @behackl in Feature: plot IntervalLabel as filled background regions when they don't hold y-data #28
• Fix typo in demo notebook by @sorlob in Update 03_Anaesthesia_Chart.ipynb #29
• Improve initialization of variable in demo notebook by @sorlob in Update 03_Anaesthesia_Chart.ipynb #30
• Make override for unit of ppg (via SpO2 %, Waveform) more robust by @behackl in Make override for unit of ppg (via SpO2 %, Waveform) more robust #37
• Update stylesheet.py for Bedmaster at CHOP by @grahamk1chop in Update stylesheet.py for Bedmaster at CHOP #44
• Add keyword argument for filtering labels by their type by @sorlob in Development orlob #34
• Use Rectangle from matplotlib to filter plotting keyword arguments of IntervalLabel by @sorlob in patched plotting routine of IntervalLabels as Rectangle #47
• fix Reconsider role of First Entry #71: Add absolute time to data frame generated by _timeseries_list_info by @sorlob in fix #71: Add absolute time to df generatedby _timeseries_list_info #83
• Reorder columns in info tables by @sorlob in Hotfix/89 merge into main #90
• Let overview plots range over full range of plotted data by default; add limited_overview keyword argument by @sorlob in Let overview plots range over full range of plotted data by default; add limited_overview keyword argument #52
• Add typing and improve implementation, documentation of datatype argument by @sorlob in Enhancement/99 importer dataclasses #102
• Various improvements to CSV / data frame loading code by @behackl in various improvements to csv / data frame loading code #104
• Feature: area under threshold calculations by @sorlob in Implemntation of Feature Request #4 - TWA MAP #77
• Add library version to exported data and check for version mismatch when loading by @behackl in Add library version to exported data and check for version mismatch when loading #106
• Fix and improve handling of time offset, allow directly setting offset attribute by @behackl in Fix and improve handling of time offset, allow directly setting offset attribute #111
• Basic support: allow None / pandas.NaT / numpy.nan in time_index by @behackl in Basic support: allow None / pandas.NaT / numpy.nan in time_index #113
• Cleanup label string data refactor (continued) by @behackl in Cleanup label string data refactor (continued) #133
• Introduce text_data for Label and IntervalLabel by @sorlob in Enhancement/69 refactor label payload #131
• Improve interface of to_csv method by @sorlob in Enhancement/141 parameter filename #143
• Minor improvements to automatic analysis methods by @sorlob in Enhancement/miscellaneous cleanup #135
• Improve code for choosing automatic preset for plot settings by @sorlob in Enhancement/142 preset menu in case of none data #146
• Refactor dropdown menu by @sorlob in fix: use dictionary for dropdown options #140
• Properly support text_data for IntervalLabel by @sorlob in integrate new label architecture into IntervalLabel #137
• Add Label for etco2 by @sorlob in added Label for etco2 #165
• Refactor input to area_under_threshold in form of new source argument by @sorlob in Refactor input to area_under_threshold in form of new source argument #175
• Add selection for annotation preset for labels by @sorlob in feat: add annotation preset type for labels #177
• Include adjacent non-included data points when plotting to avoid plots breaking at the ends by @behackl in Include adjacent non-included data points when plotting to avoid plots breaking at the ends #192
• Add first_entry and last_entry as properties of TimeSeriesBase by @sorlob in feature: added first_entry and last_entry as porpoerties of timeseries #198
• Make sure local vitabel environment is installed for Binder environments by @sorlob in enhancement: latest package version installed in binder #195
• Add visual feedback on adding partial IntervalLabel annotation by @sorlob in enhancement: visual feedback on first timepoint set for IntervalLabel #207
• Allow creating IntervalLabel by list of tuples of interval endpoints by @sorlob in enhancement: added unpacking of array of tuples of times as time_inde… #202
• Add Vitals.detach_label_from_channel as dedicated way of using data container to manage label attachments by @behackl in Add Vitals.detach_label_from_channel as dedicated way of using data container to manage label attachments #178
• Add code used in case processing of German Resuscitation Registry by @sorlob in Enhancement/resuscitation registry implementation #84
• Allow filtering channels by passing keyword arguments in more methods by @sorlob in harmonizations channel label operations, especially adding filtering #209
• feature: Add rename method to Label for updating label names by @sorlob in feature: Add rename method to Label class for updating label names #212
• Refactor Vitals.add_vitaldb_recording by @sorlob in refactor add_vitaldb_recording to load channels and labels … #215
• Improve information displayed in info table by @sorlob in Enhance _timeseries_list_info to include information about attachemen… #214
• Allow querying channels / labels by their index by @behackl in Feature: allow querying channels / labels by their index #220
• Unify input arguments and checks for automatic analysis / computation methods by @behackl in Unify input arguments and checks for automatic analysis / computation methods #219
• Improve loading routine for stryker devices to extract metadata by @sorlob in refactor: imporved loading routine for stryker devices to extract metadata #221
• Improve sorting of columns in info table by @sorlob in beautified info #216 #224
• Preparation of demo notebooks by @sorlob in preparing example notebooks for publication #144
• Add method for creating time-scaled time series by @behackl in Add method for creating time-scaled time series #227
• Add method for importing ventilatory feedback from EOlife export by @sorlob in Add method for importing ventilatory feedback from EOlife export #103

Bugfixes

• Fix textual labels on (fixed) axis height by @behackl in Fix textual labels on (fixed) axis height #25
• Improve robustness of loading ZOLL-json format by @behackl in Improve robustness of loading ZOLL-json format #42
• Use correct method for filtering labels in Vitals class by @sorlob in Fix #60 #61
• Check if artist was generated before trying to set corresponding label by @sorlob in Check if artist was generated before trying to set corresponding label #56
• Cast data time types to avoid UFuncTypeError by @sorlob in Fix #67 - UFuncTypeError #68
• Make Vitals.rec_start and Vitals.rec_stop more robust in case of no contained channels by @sorlob in Fixes #73 added that in case no channels exist the functions rec_start and rec_stop return None #74
• Handle timestamp addition type error by @sorlob in fix: handle timestamp addition type error (closes #79) #80
• Fix wrong get_labels call by @sorlob in bugfix wrong call #86
• Fix wrong type call by @sorlob in Update vitals.py #87
• Improve time type detection in TimeSeriesBase class by @sorlob in fix #81: improve time type detection in TimeSeriesBase class #82
• Check unique timestamps by @sorlob in Fix/93 check unique timestamps #94
• Improve handling of time_index containing np.NaT entries by @sorlob in hardened the code for time_indices with np.NaT resulting in divide by… #109
• Fix behavior of warning about empty time range query in get_time_mask by @sorlob in Fix behavior of warning about empty time range query in get_time_mask #122
• Fix IntervalLabel.from_dict by @sorlob in Fix IntervalLabel.from_dict to ignore vline_text_source and other irr… #170
• Set plot legend only once for axvspan by @sorlob in legend multiple times given for axvspan #166
• Make interactive plot checkbox menu population more robust by @behackl in Make interactive plot checkbox menu population more robust  #180
• Fix repainting of overview indicators after changes to overview plot by @behackl in Fix repainting of overview indicators after changes to overview plot #182
• Improve documentation and behavior of methods removing channels or labels by @behackl in Improve documentation and behavior of methods removing channels or labels #183
• Fix: make sure shift marker is redrawn when interactive plot is repainted by @behackl in Fix: make sure shift marker is redrawn when interactive plot is repainted #189
• Allow Vitals-import of pd.DataFrame with relative time index by @behackl in Allow Vitals-import of pd.DataFrame with relative time index #193
• Checked for empty channels before raising time type inconsistency error by @sorlob in fix: checked for empty channels before rasining inconsistency Error #200
• Improve robustness of (interactive) plotting when empty channels / labels are specified by @sorlob in fix: filter empty channels and labels #204
• Removed downsampling happening during vitaldb import by @sorlob in bugfix: removed downsampling by vitaldb #225 #226
• Recompute resolution based on current figure width when resizing canvas by @behackl in Recompute resolution based on current figure width when resizing canvas #239

Documentation

• Setup basic API reference documentation by @behackl in Setup basic API reference documentation #14
• API doc improvements by @behackl in API doc improvements #17
• Update README.md by @sorlob in Update README.md #40
• Improve docstrings of save_data, load_data by @sorlob in Update vitals.py #39
• Format DOIs as hyperlinks by @sorlob in Format DOIs as hyperlinks #59
• Updated docstring for get_label by @sorlob in updated docstring for get_label #66
• Improve documentation by creating various static pages and adding content to existing ones by @behackl in improve documentation #97
• Include demo notebooks as statically rendered subpages in documentation by @behackl in Include demo notebooks as statically rendered subpages in documentation #231
• Add proper bibliography in documentation by @behackl in Add proper bibliography in documentation #232
• Extend bibliography, add reference to Zotero group by @sorlob in Extend bibliography, add reference to Zotero group #237
• Miscellaneous cleanup in bibliography by @sorlob in Miscellaneous cleanup in bibliography #238

Miscellaneous

• Fix premature merge by @sorlob in fix premature merge #148
• Add screenshots depicting timeline adjustment by @sorlob in screenshots for publication - rough aligment first, detailed aligment depicted #229
• Improve timeline adjustment screenshots by @sorlob in revision improved depiction #230
• Prepare v0.1.0 by @behackl in Prepare v0.1.0 #228
• Remove output from demo notebook 3 by @sorlob in Remove output from demo notebook 3 #236

New Contributors

• @sorlob made their first contribution in Update 03_Anaesthesia_Chart.ipynb #29
• @grahamk1chop made their first contribution in Update stylesheet.py for Bedmaster at CHOP #44

Full Changelog: v0.0.1...v0.1.0

[behackl]

I've done a first pass over the automatically generated changelog, see the current status in the PR description above. This does not yet include PRs #228 nor #227, these still have to be added as soon as they are merged.

The changelog will be available in the description of the release -- see here for the previous one: https://github.com/UniGrazMath/vitabel/releases/tag/v0.0.1

[behackl]

Time to release!