smith-chem-wisc / mzLib

Library for mass spectrometry projects
GNU Lesser General Public License v3.0
26 stars 33 forks source link

Added comments to FlashLFQ #714

Closed Alexander-Sol closed 1 year ago

Alexander-Sol commented 1 year ago

FlashLFQ can be intimidating for people who need to make changes (e.g., myself.) I've added summary comments to make life a little bit easier for those people (me).

No new functionality is added in this PR. The only changes made to functional code was in FlashLfqEngine.GetIsotopicEnvelopes, where isotopic envelope correlation checking was moved to its own method.

codecov[bot] commented 1 year ago

Codecov Report

Merging #714 (9c84a85) into master (cccf686) will decrease coverage by 0.01%. The diff coverage is 96.29%.

:exclamation: Current head 9c84a85 differs from pull request most recent head 4100b55. Consider uploading reports for the commit 4100b55 to get more accurate results

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #714      +/-   ##
==========================================
- Coverage   75.64%   75.64%   -0.01%     
==========================================
  Files         155      155              
  Lines       28471    28478       +7     
==========================================
+ Hits        21537    21541       +4     
- Misses       6934     6937       +3     
Impacted Files Coverage Δ
mzLib/FlashLFQ/IsotopicEnvelope.cs 86.36% <ø> (ø)
mzLib/FlashLFQ/FlashLfqEngine.cs 89.04% <96.07%> (-0.05%) :arrow_down:
mzLib/FlashLFQ/ChromatographicPeak.cs 92.25% <100.00%> (+0.20%) :arrow_up:

... and 1 file with indirect coverage changes