This release contains a number of breaking, fixing, and useful changes.
We encourage users to review our heavily expanded documentation at
tedana.readthedocs.io
Bug Fixes:
- PCA has been overhauled to a new and more reliable method, averting a known
bug where too many PCA components would be selected.
- Environments are not coerced to single-threaded computation after calling
tedana.
- Fixed variance-explained outlier detection problem where first value was
always NaN and variance explained was always negative.
- Fixed component table loading bug that resulted from unexpected pandas
behavior.
- Fixed bug where the wrong number of echoes would be allocated in-program.
- Fixed bug where only selecting one component would cause an error.
- Correctly incorporate user-supplied masks in T2* workflow.
- Fixed bug in PAID combination where mean of data would be used instead of SNR.
Breaking Changes:
- Log files are now by datetime, allowing multiple runs to have systematic
naming.
- Filenames for decomposition and metric maps are now BIDS
derivative-compatible. Please see documentation for the full list of new
filenames.
- Component tables are now in .json format
- Changed tab-separated files from .txt to .tsv file extension.
- Removed the --sourceTEs option.
- T2* maps are now in seconds rather than milliseconds.
- --mle option is now deprecated.
Changes in Defaults:
- New PCA algorithm is default, please see documentation for more information.
- Clustering is now bi-sided rather than two sided (positive and negative
clusters are now grouped separately).
- Static png images are now the default; use --nopng to avoid this.
- Files are now gzipped by default.
New Features:
- Massively expanded documentation, please see tedana.readthedocs.io to view
the updated usage help, multi-echo background, developer guidelines, and
API documentation.
- New PCA decomposition algorithm (default).
- Adds the --out_dir argument to t2smap workflow to choose what directory files are written
to.
- t2smap workflow is now fmriprep compatible
- Added --t2smap argument to allow you to supply a precalculated T2* map.
Thanks to Logan Dowdle, Elizabeth DuPre, Cesar Caballero Gaudes, Dan
Handwerker, Ross Markello, Isla, Joshua Teves, Eneko Urunuela,
Kirstie Whitaker, and to the NIH Section on Functional Imaging Methods
for supporting the tedana hackathon and the NIH for supporting the AFNI Code Convergence, where much of the work in this release was done.