Skip to content

Commit

Permalink
Update changelog and CFF for 0.7.2 release (PennLINC#1155)
Browse files Browse the repository at this point in the history
  • Loading branch information
tsalo authored Apr 24, 2024
1 parent 5acdb0b commit 88945c5
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,5 @@ keywords:
- BIDS-App
- Neuroimaging
license: BSD-3-Clause
version: 0.7.1
date-released: '2024-04-19'
version: 0.7.2
date-released: '2024-04-24'
18 changes: 18 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ See the `documentation <https://xcp-d.readthedocs.io/en/latest/>`_ for more deta

Why you should use XCP-D
````````````````````````

XCP-D produces the following commonly-used outputs: matrices, parcellated time series,
dense time series, and additional QC measures.

Expand All @@ -79,6 +80,7 @@ as well as decomposition-based methods, such as ICA or NMF.

When you should not use XCP-D
`````````````````````````````

XCP-D is not designed as a general-purpose postprocessing pipeline.
It is really only appropriate for certain analyses,
and other postprocessing/analysis tools are better suited for many types of data/analysis.
Expand All @@ -88,3 +90,19 @@ such as psychophysiological interactions (PPIs) or beta series analyses.
It is also not suitable for general task-based analyses, such as standard task GLMs,
as we recommend included nuisance regressors in the GLM step,
rather than denoising data prior to the GLM.


************
Citing XCP-D
************

If you use XCP-D in your research, please use the boilerplate generated by the workflow.
If you need an immediate citations, please cite the following preprint:

Mehta, K., Salo, T., Madison, T., Adebimpe, A., Bassett, D. S., Bertolero, M., ... & Satterthwaite, T. D.
(2023).
XCP-D: A Robust Pipeline for the post-processing of fMRI data.
*bioRxiv*.
doi:10.1101/2023.11.20.567926.

Please also cite the Zenodo DOI for the version you're referencing.
20 changes: 19 additions & 1 deletion docs/changes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# What's New

<!-- Release notes generated using configuration in .github/release.yml at main -->
## 0.7.2

This is a patch release fixing small bugs in 0.7.1.

### 🎉 Exciting New Features

* Make `GeneratedBy` in preprocessing derivatives' `dataset_description.json` optional by @tsalo in https://github.com/PennLINC/xcp_d/pull/1151

### 🐛 Bug Fixes

* Fix exit code bug in `cli.run.main()` by @tsalo in https://github.com/PennLINC/xcp_d/pull/1152

### Other Changes

* Replace pkgrf with load_data by @tsalo in https://github.com/PennLINC/xcp_d/pull/1147
* Update to new build image (v0.0.12) by @tsalo in https://github.com/PennLINC/xcp_d/pull/1153

**Full Changelog**: https://github.com/PennLINC/xcp_d/compare/0.7.1...0.7.2


## 0.7.1

Expand Down

0 comments on commit 88945c5

Please sign in to comment.