Tutorials and workshops describing and explaining the infrastructure for mass spectrometry (MS) data analysis centered around Bioconductor's Spectra package.

These Workshops are also given (either in-person or virtually) at various conferences. If available, recordings of these are linked below in the respective workshop section.

See NEWS.md for information on the current version and a change log.

This tutorials (and future versions) are deposited at Zenodo. To cite this version of the tutorial:

Rainer J, Louail P, Witting M, Gatto L, Gibb S (2024). SpectraTutorials version 1.0.0: Mass Spectrometry Data Analysis with Spectra. Zenodo. https://doi.org/10.5281/zenodo.11210190

For on-line code evaluation the workshops can also be run using a self-contained docker image with all R packages and a server version of RStudio (Posit) pre-installed. The current docker container bases (and includes) the official docker container for Bioconductor release 3.19. As an alternative, rendered versions of all workshops are available at SpectraTutorials (navigate to the Articles drop-down menu and select the workshop of interest).

For installation:

• Get the docker image of this tutorial with docker pull jorainer/spectra_tutorials:RELEASE_3_19.
• Start docker using

  docker run \
      -e PASSWORD=bioc \
      -p 8787:8787 \
      jorainer/spectra_tutorials:RELEASE_3_19
  

• Enter http://localhost:8787 in a web browser and log in with username rstudio and password bioc.
• In the RStudio server version: open any of the R-markdown (.Rmd) files in the vignettes folder and evaluate the R code blocks.

rendered version

In this workshop we will use Spectra to:

• import MS data from mzML files,
• select MS2 spectra for a certain compound,
• compare and match the MS2 spectra against reference MS2 spectra from a public database,
• annotate the spectra and export them to a file in MGF format.

This (instructor-led live demo) workshop explains the Spectra package and shows how this new infrastructure can be used to represent and analyze Mass Spectrometry (MS) data. The use of different data type and format specific backends guarantees an easy expandability of the infrastructure. This is illustrated in this tutorial on a simple use case, in which MS/MS (a.k.a. MS2) spectra, measured by an MS instrument, are compared and matched against a public spectral database containing public domain reference MS2 spectra.

The video recording of this workshop at the BioC2021 conference is available here.

The video recording of this workshop at the EuroBioc2020 conference is available here.

• Understand how to import MS data into R.
• Understand the basic concept how different backends can be used in Spectra to work with MS data from various sources.

• Import and export MS data with Spectra.
• Integrate MS data from different resources into an MS data analysis workflow.
• Apply different data manipulations on MS data represented as a Spectra object.
• Use Spectra to perform spectra comparisons in R.

• Basic familiarity with R and Bioconductor.
• Basic understanding of Mass Spectrometry (MS) data.

• Spectra
• MsCoreUtils
• MsBackendMgf
• MsBackendMassbank
• CompoundDb

rendered version

• Explain different representations of mass spectrometry data along with their properties and advantages.
• Explain the caching and lazy processing queue of the Spectra package.

The Spectra package provides a modern infrastructure for MS data handling specifically designed to enable extension to additional data resources or alternative data representations. These can be realized by extending the virtual MsBackend class and its related methods. Implementations of such MsBackend classes can be tailored for specific needs, such as low memory footprint, fast processing, remote data access, or also support for specific additional data types or variables. Importantly, data processing of Spectra objects is independent of the backend in use due to a lazy evaluation mechanism that caches data manipulations internally.

This workshop discusses different available data representations for MS data along with their properties, advantages and performances. In addition, Spectra's concept of lazy evaluation for data manipulations is presented, as well as a simple caching mechanism for data modifications. Finally, it explains how new MsBackend instances can be implemented and tested to ensure compliance.

• Basic familiarity with R and Bioconductor.
• Basic understanding of Mass Spectrometry (MS) data.

• Spectra
• MsBackendSql

This is a more technical demonstration of the internals of the Spectra package and design of its MS infrastructure. We're not demonstrating any use cases or analysis workflows here.

• Understand how MS data is handled with Spectra.
• Understand differences and properties of different MsBackend implementations.

• Learn how MS data is handled with Spectra.
• Understand which data representations/backends fit which purpose/use case.
• Insights into the internals of the Spectra MS infrastructure to facilitate implementation of own backend(s).

rendered version

The Spectra package provides all the functionality required for annotation and identification workflows for untargeted LC-MS/MS data, but, while being very flexible and customizable, it might be too cumbersome for beginners or analysts not accustomed with R. To fill this gap we developed the MetaboAnnotation package that builds upon Spectra and provides functions for annotation of LC-MS and LC-MS/MS data sets tailored towards the less experienced R user.

This tutorial shows how MetaboAnnotation can be used in R-based LC-MS/MS annotation workflows.

Note that there is also an additional tutorial for the MetaboAnnotation, CompoundDb and MetaboCoreUtils packages available: MetaboAnnotationTutorials.

For contributions, see the RforMassSpectrometry contributions guideline.

See the RforMassSpectrometry Code of Conduct.

Thank you to Philippine Louail for fixing typos and suggesting improvements in the Spectra: an expandable infrastructure to handle mass spectrometry data.