rformassspectrometry / Spectra

Low level infrastructure to handle MS spectra
https://rformassspectrometry.github.io/Spectra/
37 stars 25 forks source link

dataStorage and dataOrigin semantics #179

Closed meowcat closed 3 years ago

meowcat commented 3 years ago

Hi,

question: is there any specific guidance of how dataStorage and dataOrigin should work? Or is this up to the backend?

For example, if I have a text format backend and I want to specify how to split the output into different files on export, would it be an acceptable use to set one of these fields correspondingly? Or should I add an additional variable like "exportTarget" for that?

jorainer commented 3 years ago

The dataStorage is defined in the backend and you should not change that (for on-disk backends this keeps the information where the data is stored).

The dataOrigin should allow to keep track where the data comes from (e.g. the originating mzML file). There is no constraint on this variable, so it can be changed by the user.

For your use case I would suggest to add a new variable instead of using one of these.

meowcat commented 3 years ago

Thanks for the clarification!