Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Default spectra variable names #62

Open
jorainer opened this issue Sep 17, 2020 · 8 comments
Open

Default spectra variable names #62

jorainer opened this issue Sep 17, 2020 · 8 comments

Comments

@jorainer
Copy link
Member

As suggested by @michaelwitting in issue #61 we should agree on a base nomenclature for compound/spectra identifiers. I am generally no big friend of camelCase in variable names (just too easy to misstype), so I'd suggest to use all in lower case?

Happy for feedback, change requests and expansion of the list @michaelwitting @stanstrup @sneumann

  • InChI: inchi
  • InChIKey: inchikey
  • SMILES: smiles
  • SPLASH: splash
    ...
@stanstrup
Copy link
Collaborator

Unsure what kind of things go here exactly.

  • cas
  • local_identifier
  • mslevel
  • manufacturer
  • ionmode
  • precursormz

@michaelwitting
Copy link
Collaborator

  • formula formula
  • adduct adduct

@michaelwitting
Copy link
Collaborator

Once we agreed on a format, I would like to refactor this in MsBackendMassbank, so they spectra can be directly used without any reformatting

@jorainer
Copy link
Member Author

I would suggest to always use the default for the core spectra variables (see the list of variables in the General description of the Spectra vignette. Thus I would use:

  • msLevel instead of mslevel.
  • precursorMz instead of precursormz.
  • polarity instead of ionmode (if you mean that @stanstrup )

(note my lack of consistency here - sorry for that :( )

@michaelwitting
Copy link
Collaborator

To summarize so far.
We have the spectra core variables:

  • acquisitionNum
  • centroided
  • collisionEnergy
  • dataOrigin
  • dataStorage
  • intensity
  • isolationWindowLowerMz
  • isolationWindowTargetMz
  • isolationWindowUpperMz
  • msLevel
  • mz
  • polarity
  • precScanNum
  • precursorCharge
  • precursorIntensity
  • precursorMz
  • rtime
  • scanIndex
  • smoothed

And our "library" variables (plus a few more suggestion from my side)

  • name (required)
  • exactmass (required)
  • adduct (required)
  • formula (required)
  • splash (required)
  • inchi (optional)
  • inchikey (optional)
  • smiles (optional)
  • cas (optional)
  • localidentifier (optional)

In case of lipids we often don' have the exact structure, therefore I would like to have inchi, inchikey, smiles optional.

@jorainer
Copy link
Member Author

OK, this means I should update/change the code in CompoundDb to use these new column names, right?

@michaelwitting
Copy link
Collaborator

I would guess so... If there are no objections from @stanstrup ?

jorainer added a commit that referenced this issue Sep 25, 2020
- Rename `compound_name` to `compound`, `inchi_key` to `inchikey` and `mass` to
  `exactmass`.
@stanstrup
Copy link
Collaborator

No objections

jorainer added a commit that referenced this issue Sep 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants