Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flag peaks2maps for removal in 0.0.13/0.1.0 #616

Merged
merged 4 commits into from
Dec 16, 2021

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Dec 10, 2021

Closes #615, though I won't mark this as ready to review this until we have a consensus in that issue.

Changes proposed in this pull request:

  • Add "deprecated" directive to docstrings of functions and classes related to the Peaks2Maps algorithm.
  • Add a deprecation warning to Peaks2MapsKernel.

@codecov
Copy link

codecov bot commented Dec 10, 2021

Codecov Report

Merging #616 (1669c5c) into main (16f06b0) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #616   +/-   ##
=======================================
  Coverage   85.76%   85.76%           
=======================================
  Files          40       40           
  Lines        4390     4391    +1     
=======================================
+ Hits         3765     3766    +1     
  Misses        625      625           
Impacted Files Coverage Δ
nimare/cli.py 97.26% <ø> (ø)
nimare/extract/extract.py 51.48% <ø> (ø)
nimare/meta/utils.py 88.70% <ø> (ø)
nimare/workflows/peaks2maps.py 37.50% <ø> (ø)
nimare/meta/kernel.py 96.51% <100.00%> (+0.02%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 16f06b0...1669c5c. Read the comment docs.

@tsalo tsalo added the cbma Issues/PRs pertaining to coordinate-based meta-analysis label Dec 14, 2021
@tsalo tsalo added the deprecation Classes/functions/behaviors flagged for later removal. label Dec 14, 2021
@tsalo tsalo changed the title [MAINT] Deprecate peaks2maps Flag peaks2maps for removal in 0.0.13/0.1.0 Dec 14, 2021
@tsalo tsalo mentioned this pull request Dec 14, 2021
@tsalo tsalo marked this pull request as ready for review December 14, 2021 17:55
@tsalo
Copy link
Member Author

tsalo commented Dec 16, 2021

No objections have been raised, so I'm merging this.

@tsalo tsalo merged commit 2fbbf60 into neurostuff:main Dec 16, 2021
@tsalo tsalo deleted the deprecate-peaks2maps branch December 16, 2021 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cbma Issues/PRs pertaining to coordinate-based meta-analysis deprecation Classes/functions/behaviors flagged for later removal.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate Peaks2MapsKernel
1 participant