Skip to content
This repository has been archived by the owner on Sep 2, 2023. It is now read-only.

Commit

Permalink
changelog: document changes
Browse files Browse the repository at this point in the history
  • Loading branch information
fphammerle committed Jul 11, 2020
1 parent 627efc3 commit 2dce77e
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions CHANGELOG.md
Expand Up @@ -10,16 +10,64 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- package metadata: added `python3.8` classifier

## [2.0.0] - 2019-08-08
### Changed
- python library: split class `SubfieldVolumeFile` from `VolumeFile`

### Added
- python library: class `ashs.IntracranialVolumeFile`
- examples:
- added ASHS
- added comparison FreeSurfer vs. ASHS

### Fixed
* install: no longer require runtime dependencies to run `setup.py`

## [1.0.0] - 2019-05-05
### Changed
- console entry point `freesurfer-volume-reader`:
- exit with code `EX_NOINPUT`/`66` in case no matching volume files were found
(previously: exception with exit code `1`)
- renamed param `--filename-regex` to `--freesurfer-hipposf-filename-regex`
- python library:
- renamed `read_hippocampal_volume_file_dataframe()`
to `freesurfer.HippocampalSubfieldsVolumeFile.read_volumes_dataframe()`
- renamed `read_hippocampal_volumes_mm3()`
to `freesurfer.HippocampalSubfieldsVolumeFile.read_volumes_mm3()`
- renamed `parse_hippocampal_volume_file_path()`
to `freesurfer.HippocampalSubfieldsVolumeFile.__init__()`
- renamed `find_hippocampal_volume_files()`
to `freesurfer.FreesurferHippocampalVolumeFile.find()`

### Added
- console entry point `freesurfer-volume-reader`:
- flag `--version` to show version
- param `--source-types` to optionally enable collection of ASHS `*volumes.txt` files
(default: freesurfer only)
- param `--ashs-filename-regex`
- python library: added class `ashs.HippocampalSubfieldsVolumeFile`
to find & read ASHS *volumes.txt files

## [0.2.1] - 2019-04-28
### Fixed
- added pandas version constraint (required for `pandas.DataFrame.drop`)

## [0.2.0] - 2019-04-28
### Added
- accept multiple args for positional param `root_dir_paths`

### Fixed
- invalid root path when `$SUBJECTS_DIR` is set and root dir path is provided as positional arg

## [0.1.1] - 2019-04-27
### Fixed
- test `read_hippocampal_volume_file_dataframe` on python3.5

## [0.1.0] - 2019-04-26
### Added
- script `freesurfer-volume-reader`:
- recursively collect Freesurfer's hippocampal subfield volume files
- output in CSV-format
- python module `freesurfer_volume_reader`

[Unreleased]: https://github.com/fphammerle/freesurfer-volume-reader/compare/2.0.0...HEAD
[2.0.0]: https://github.com/fphammerle/freesurfer-volume-reader/compare/1.0.0...2.0.0
Expand Down

0 comments on commit 2dce77e

Please sign in to comment.