search

ME-ICA / mapca

A Python implementation of the moving average principal components analysis methods from GIFT
GNU General Public License v2.0
6 stars 8 forks source link

Make criteria curves accessible as part of the mapca object #43

Closed eurunuela closed 2 years ago

eurunuela commented 2 years ago

Closes none.

This PR makes the aic, kic and mdl criteria curves accessible as mapca.aic, mapca.kic and mapca.mdl.

The main purpose of this PR is to give users the chance to look at the optimization curves.

codecov-commenter commented 2 years ago

Codecov Report

Merging #43 (8adaa2f) into main (a37d815) will not change coverage. The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #43   +/-   ##
=======================================
  Coverage   90.42%   90.42%           
=======================================
  Files           3        3           
  Lines         282      282           
=======================================
  Hits          255      255           
  Misses         27       27
Impacted Files Coverage Δ
mapca/mapca.py 86.82% <100.00%> (ø)

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 a37d815...8adaa2f. Read the comment docs.

eurunuela commented 2 years ago

I noticed some minor docstring formatting things. Also, I think that sklearn's convention for attributes defined by the fit method is to include a trailing underscore in the name (e.g., self.aic_. I think it might be nice to adopt that convention, since many of our users will also be sklearn or nilearn users, but if you don't want to that's fine too.

I didn't know about that. Thank you @tsalo !