[ENH] Add option to return nulls in compare_images()

[justinehansen]

Added a new parameter return_nulls to neuromaps.stats.compare_images(). If True and nulls is not None, compare_images() will return the similarity metric, p-value, and the distribution of null similarity metrics used to generate the p-value. See Issue #93 for some discussion on this.

[codecov-commenter]

Codecov Report

Merging #97 (b606da3) into main (96ff4f0) will increase coverage by 0.04%.
The diff coverage is 55.55%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main      #97      +/-   ##
==========================================
+ Coverage   41.10%   41.15%   +0.04%     
==========================================
  Files          40       40              
  Lines        2474     2481       +7     
==========================================
+ Hits         1017     1021       +4     
- Misses       1457     1460       +3     

Impacted Files	Coverage Δ
neuromaps/nulls/spins.py	36.86% <0.00%> (ø)
neuromaps/stats.py	53.21% <62.50%> (+0.26%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[justinehansen]

Thanks @FilipMorys for catching the bug in get_parcel_centroids() in spins.py! With this PR we load the parcellation file in get_parcel_centroids() before calling its attributes.