OpenMS / pyopenms-docs

pyOpenMS readthedocs documentation, additional utilities, addons, scripts, and examples.
https://pyopenms.readthedocs.io
Other
42 stars 52 forks source link

Doc/spectramerger #265

Closed JangJang3 closed 6 months ago

JangJang3 commented 2 years ago

Adding a tutorial on spectra merging.

timosachsenberg commented 2 years ago

maybe depends on the MS level

timosachsenberg commented 2 years ago

Looks much better.

timosachsenberg commented 2 years ago

I added a small change to simplify the description a bit. Can you give it a re-read the text for consistency? There seem to be some ambiguities: e.g. Per default, the method mergeSpectraBlockWise of SpectraMerger merges MS1 spectra blockwise and in the example code it says:

# merges blocks of MS1 or MS2 spectra
merger = SpectraMerger()

This might be confusing for beginners. I think we need to try to describe the methods as simple and as consistent as possible.

JangJang3 commented 2 years ago

I added a small change to simplify the description a bit. Can you give it a re-read the text for consistency? There seem to be some ambiguities: e.g. Per default, the method mergeSpectraBlockWise of SpectraMerger merges MS1 spectra blockwise and in the example code it says:

# merges blocks of MS1 or MS2 spectra
merger = SpectraMerger()

This might be confusing for beginners. I think we need to try to describe the methods as simple and as consistent as possible.

Hmm you're right, I might have mixed some beginner information with intermediates...I'll change it

sonarcloud[bot] commented 2 years ago

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

timosachsenberg commented 2 years ago

is this done?