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

Add readthedocs page for mapca #46

Open eurunuela opened 2 years ago

eurunuela commented 2 years ago

Closes #42 .

This PR adds the documentation related to the package.

codecov-commenter commented 2 years ago

Codecov Report

Merging #46 (1e8a8db) into main (0ae41bb) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #46   +/-   ##
=======================================
  Coverage   90.42%   90.42%           
=======================================
  Files           3        3           
  Lines         282      282           
=======================================
  Hits          255      255           
  Misses         27       27

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 0ae41bb...1e8a8db. Read the comment docs.

handwerkerd commented 2 years ago

Great start! My one general comment is that, as a learning tool, it would be nice to have a few more "why" comments instead of the current "what" comments. That is, you include things like "Step 2: Apply kurtosis threshold of Gaussianity to SVD data to get first estimate of subsampling depth" without saying why this step is happening. This doesn't have to be a textbook level of detail, but a sentence or two at the beginning of each code block explain why each step is done would help.