[CV] units and more detailed description of how to compute metrics about mzqc HOT 5 CLOSED

Whether or not to include units in the CV has been a topic of some discussion already. In the end we settled on having explicit units for the quality metrics in the mzQC files.

There should indeed be restrictions on some values. This is part of what the semantic validation of the official Python parser checks. So far we haven't made these restrictions explicit in the CV, but it might be relevant to consider that.

from mzqc.

Overview of semantic validation in issue #50. Please add any checks that should still be included.

from mzqc.

I agree, that many CVs need further description. It would be great, if the inventors of the metrics, or the persons who created them in their programs/workflows/pipelines could provide a better description.

The descriptions used by me so far where from some documents I found when I started to take over the CV or my own tries to interpret the CV.

The best way to get good descriptions for the items in the CV would be, if you could open an request-new-CV-entry-issue with the description etc.
(I know, I did not have much time in the last weeks, but should have some more to finish v1.0 now).

from mzqc.

Probably the best way to get better descriptions is to ping the tool developers directly and explicitly mention the metrics that need to be improved. Otherwise I'm afraid not much will happen, as I doubt that many people will have seen this issue. :)

from mzqc.

This will be handled by the "comment" information in the CV and the requirements for better descriptions in the future.

from mzqc.