Skip to content

DOC: expand explanation on why generic MCC methods are suboptimal (Is… - #1127

Open
Achintyasingh412 wants to merge 3 commits into
neurostuff:mainfrom
Achintyasingh412:docs-improve-mcc
Open

DOC: expand explanation on why generic MCC methods are suboptimal (Is…#1127
Achintyasingh412 wants to merge 3 commits into
neurostuff:mainfrom
Achintyasingh412:docs-improve-mcc

Conversation

@Achintyasingh412

@Achintyasingh412 Achintyasingh412 commented Sep 1, 2026

Copy link
Copy Markdown
Screenshot 2026-09-01 072018 Screenshot 2026-09-01 072018 …sue #912)

Closes # .

Changes proposed in this pull request:

Summary by Sourcery

Documentation:

  • Expand the CBMA documentation with additional explanation of why generic multivariate coordinate-based meta-analysis methods may be suboptimal.

@sourcery-ai

sourcery-ai Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This documentation-only change expands the CBMA guidance around the limitations of generic MCC methods, helping reviewers verify that the explanation is accurate, clear, and consistent with the documented analysis workflow.

File-Level Changes

Change Details Files
Expanded the CBMA documentation to explain why generic MCC methods can be suboptimal and to motivate more appropriate analysis choices.
  • Added six lines of explanatory guidance describing limitations of generic MCC approaches and their implications for users.
docs/cbma.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@jdkent jdkent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution, since you are referencing papers, we can cite them using restructured text, you will need to either add/use the reference in this file: https://github.com/neurostuff/NiMARE/blob/main/nimare/resources/references.bib

and cite it like :footcite:p:smith2009threshold in the document.

Comment thread docs/cbma.rst

It can be applied to coordinate-based meta-analyses as an alternate metric to the
maximum summary statistic (``level-voxel``), cluster mass (``desc-mass``), or cluster size (``desc-size``).
However, recent work by Frahm et al. :footcite:p:`frahm2022evaluation` has indicated that the costs of performing

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here is an example of a citation.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Hi @jdkent, thank you for the helpful review and the citation example! I'll update the formatting right away and push the fix shortly."

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sourcery assessment

Approved.

@Achintyasingh412

Copy link
Copy Markdown
Author

Hi @jdkent, thank you for the guidance! I've updated the Frahm citation to use the :footcite:p: format as requested Please let me know if it looks good to go now.

@jdkent jdkent left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the change, please add a citeation for Eickhoff as well.

Comment thread docs/cbma.rst Outdated
Generic multiple-comparison correction methods fail to properly account for
the spatial smoothness, correlation, and null distribution characteristics
unique to coordinate-based meta-analyses like ALE. As outlined by
Eickhoff et al. (2016) and Frahm et al. :footcite:p:`frahm2022evaluation`,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add the citation for Eickoff et al. 2016 as well.

@Achintyasingh412

Copy link
Copy Markdown
Author

Hi @jdkent, thanks for catching that! I've added the Sphinx footcite tag for Eickhoff et al. (2016) right alongside Frahm. Please let me know if everything looks good to go now

@Achintyasingh412

Copy link
Copy Markdown
Author

Hey @jdkent, just dropping a friendly ping on this PR whenever you have a spare moment to review. Let me know if any adjustments or further clarifications are needed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants