DSP.jl icon indicating copy to clipboard operation
DSP.jl copied to clipboard

[DOCS] Add Small Note about Method Validations

Open TheCedarPrince opened this issue 1 year ago • 4 comments

Hey there!

After a discussion with @ericphanson , I learned that DSP.jl is actually validated against MATLAB and MNE-Python! In my eyes, that made using DSP.jl much more salient to me in knowing that, although its methods are made in Julia from scratch, they are compared with suites that are considered state of the art in many domains. I know it is a small edit, but I thought it was worthwhile enough to update the docs here because if I think that way, it may appeal to other folks thinking similarly.

TheCedarPrince avatar Jun 21 '24 15:06 TheCedarPrince

DSP.jl is actually validated against MATLAB and MNE-Python

I think that is only true for part of DSP.jl.

martinholters avatar Jun 24 '24 10:06 martinholters

Here is the context btw: https://discourse.julialang.org/t/decomposing-an-eeg-signal-from-scratch/115904/6

ericphanson avatar Jun 24 '24 10:06 ericphanson

That's very reasonable @martinholters -- I updated my PR to reflect that point.

TheCedarPrince avatar Jun 25 '24 19:06 TheCedarPrince

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.74%. Comparing base (76001f4) to head (07afedc).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #561   +/-   ##
=======================================
  Coverage   97.74%   97.74%           
=======================================
  Files          18       18           
  Lines        3199     3199           
=======================================
  Hits         3127     3127           
  Misses         72       72           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jun 25 '24 19:06 codecov[bot]

I'm merging for now, but it can easily be fine tuned later.

ViralBShah avatar Aug 08 '24 21:08 ViralBShah