Releases: bhklab/readii
v1.34.1
v1.34.0
v1.34.0 (2024-12-31)
Features
Summary by CodeRabbit
- New Features
- Added an optional
overwrite
parameter to correlation plotting functions - Enhanced control over file saving behavior when generating correlation plots
- Users can now choose whether to replace existing plot files
Detailed Changes: v1.33.0...v1.34.0
v1.33.0
v1.33.0 (2024-12-30)
Features
Makes it easier to catch times when file exists without resolving the path twice
Summary by CodeRabbit
-
New Features
-
Added a new, more specific exception for handling file existence scenarios during correlation writing.
-
Documentation
- Updated method documentation to reflect new error handling behavior.
Detailed Changes: v1.32.0...v1.33.0
v1.32.0
v1.32.0 (2024-12-30)
Features
add self and cross correlation plot functions
## Summary by CodeRabbit- New Features
- Introduced functionality for plotting self and cross correlation heatmaps and histograms.
- Added methods for generating histograms with customizable parameters and optional saving options.
- Bug Fixes
- Enhanced error handling for plot saving to prevent overwriting existing files.
- Tests
- Added a comprehensive suite of unit tests for correlation plotting functionalities, ensuring correct outputs and file handling.
Detailed Changes: v1.31.0...v1.32.0
v1.31.0
v1.31.0 (2024-12-19)
Features
## Summary by CodeRabbit-
New Features
-
Enhanced correlation analysis methods for improved clarity and functionality.
-
Introduced a new method to retrieve both self and cross correlations in a single call.
-
Bug Fixes
-
Improved error handling for cases with no matching features, providing specific error messages.
-
Documentation
- Updated public API to reflect new method names and signatures.
Detailed Changes: v1.30.0...v1.31.0
v1.30.0
v1.30.0 (2024-12-19)
Features
Didn't test updating from os to pathlib enough, but should be good now. Added basic test, needs to be expanded upon.
## Summary by CodeRabbit-
New Features
-
Introduced a new variable for improved file path handling in the feature loading process.
-
Added a comment for clarity on retrieving the full path to the feature file.
-
Bug Fixes
-
Updated logic for removing the image type file from the feature files list.
-
Tests
-
Added a new test function to validate the functionality of the feature loading function.
- Implemented a fixture for testing with a temporary feature file.
Detailed Changes: v1.29.1...v1.30.0
v1.29.1
v1.29.1 (2024-12-18)
Bug Fixes
Summary by CodeRabbit
-
New Features
-
Improved file matching logic for identifying features based on image types.
-
Enhanced clarity in handling scenarios for matching files with updated control flow.
-
Bug Fixes
-
Retained consistent error handling with appropriate logging for warnings and exceptions.
Detailed Changes: v1.29.0...v1.29.1
v1.29.0
v1.29.0 (2024-12-18)
Features
Created CorrelationWriter class for the analyze portion of the pipeline.
I think there will eventually be a FeatureSetWriter that this should probably inherit from, but I need the Correlation one now for Aerts.
## Summary by CodeRabbit-
New Features - Introduced a
CorrelationWriter
class for managing the writing of correlation data to files with customizable paths and filenames. - Added support for saving correlation data in both CSV and Excel formats. -
Bug Fixes - Implemented error handling for invalid correlation data, existing files, and filename format validation.
-
Tests - Added a comprehensive suite of unit tests for the
CorrelationWriter
class, covering various scenarios for saving correlation data.
Co-authored-by: Jermiah Joseph [email protected]
Detailed Changes: v1.28.0...v1.29.0
v1.28.0
v1.28.0 (2024-12-18)
Features
Updated include list to have the io/readers functions and updated the files so all ruff tests pass.
## Summary by CodeRabbit-
New Features
-
Enhanced flexibility in loading feature files by accepting both
Path
objects and strings. -
Improved error handling and logging for file loading and directory access.
-
Bug Fixes
-
Enhanced error handling and logging for file loading and directory access, providing clearer context for issues.
-
Documentation
-
Updated docstrings for functions to improve clarity and detail, including return type annotations.
Detailed Changes: v1.27.0...v1.28.0
v1.27.0
v1.27.0 (2024-12-17)
Features
Includes correlation calculations and plotting those correlations as a heatmap and histogram
-
New Features - Updated version number to 1.26.0 with new dependencies:
numpy
,seaborn
, andpandas
. - Introduced a new module for analyzing READII outputs with several correlation functions. - Added visualization functions for correlation data: heatmap and histogram. - New validation function for DataFrame dimensions added. - Expanded platform support to includeosx-64
andwin-64
. -
Bug Fixes - Enhanced error handling in correlation calculations and plot saving processes. - Simplified exception handling in feature loading functions.
-
Documentation - Improved docstrings for new functions and modules for better usability.
-
Chores - Expanded linting configuration for broader coverage of Python files.
Detailed Changes: v1.26.0...v1.27.0