MetaboliteAnnotationWorkflow

An R script for the annotation of small-molecule LC-MS data

This repository contains full workflow application for annotating a full signal intesity matrix and MS2 spectra recieved from SLAW (see https://github.com/zamboni-lab/SLAW for further details) with MS1/MS2 annotation with the MetaboAnnotation package (see https://github.com/rformassspectrometry/MetaboAnnotation). The workflow works with the output from the SLAW stable release or the SLAW developmental version.

Usage

The workflow can be simply used from the command line by calling the main script MetaboliteAnnotationWorkflow.R

Rscript MetaboliteAnnotationWorkflow.R

If no input parameters are supplied a demo data set is used. Otherwise three different command line arguments are required:

• input folder: This folder contains the output from SLAW. Data needs to be organized into two subfolders output_slaw_pos and output_slaw_neg.

• output folder: All results will be stored in this folder.

• library folder: This folder contains all MS^1^ and MS^2^ libraries. Libraries are organized in subfolder:

  • MS1_inhouse_pos:

  • MS1_inhouse_neg

  • MS1_external_pos

  • MS1_external_neg

  • MS2_inhouse_pos

  • MS2_inhouse_neg

  • MS2_external_pos

  • MS2_external_neg

The following command calls the different input folders explicitly:

Rscript MetaboliteAnnotationWorkflow.R Demo/new/test_input Demo/new/test_output Demo/test_library

Input Parameter

Processing parameter are defined in the settings.yaml file that need to be present in the input folder.

All required input parameters are stored in a yaml-file. See test_input/settings.yaml for a example settingsfile. Following parameters need to be provided: - cores: Defining on how many cores the calculatation shall be performed.

• tolerance_MS1 and tolerance_MS2: Defining the absolute allowed tolerance for annotation.
• ppm_MS1 and ppm_MS2: Defining the relative allowed tolerance.
• adducts_pos and adducts_neg which are calculated for MS1 annotation.
• dp_tresh the dot product score threshold applied for annotation.
• int_tresh defining the relative intensity threshold which will be removed from the MS2 query sepctra.
• toleranceRT_MS1 and toleranceRT_MS2 defining the window in retention time in seconds used for annotation.
• output_dir which is defining the directory to store the result data.
• save_rds a logical (TRUE/FALSE) defining if all calculated objects shall be stored. These can be easy loaded again into e.g. an R session.
• save_tsv a logical (TRUE/FALSE) defining if match results should be provided as tsv.

Input Data

All required input variables are stored in a yaml-file. See test_input/settings.yaml for a example settingsfile. Here, we define the paths for following input files: - The slaw output containing the datamatrix and fused mgf file to use for both ionization modes - studydesign_pos and studydesign_neg: A *.csv file containing the Sample metadata used to be stored in the colData of the final SummarizedExperiment (optional if parameter samplegroup=TRUE).

• Input library directories (positive and negative mode) containg the MS1 annotation lists. Two different directories can be provided distiguishing between inhouse-data inhouse and extern data ext. For inhouse data, an additional retention time matching will be performed.

The *.csv files should contain the rows:

While retention time is only needed for the inhouse file.

• Input library directories (positive and negative mode) containing the MS2 spectral libraries. Following input formats are supported:
  • *.mb as MassBank record file
  • *.msp as MS2 MSP file
  • *.rds a Spectra object containing the library spectra

Output Data

In the output directory following directories will be created: - Annotation_MS1_external: Containing the result files of the MS1 annotation without retention time.

• Annotation_MS1_inhouse: Containing the result files of the MS1 annotation with retention time.
• Annotation_MS2_external: Containing the result files of the MS2 annotation without retention time.
• Annotation_MS2_inhouse: Containing the result files of the MS2 annotation with retention time.
• QFeatures_MS1: Containing *.rds files with the QFeatures SummarizedExperiment objects.

Evaluate Data

• If the matchedSpectra Objects are stored (settings parameter save_rds= TRUE), these can be reviewed by using the command:

Rscript ShinyMetaboAnnotation/app.R [matchedObject.rds]

The used MatchedObject can be either defined by the commandline argument or later loaded in later in the Shiny application. Alternatively, the application can be opened in RStudio and using the run application button in the top of the source.

By clicking on the Browse... button, a rds file containing a MatchedSpectra Object can be loaded.

The side panel contains all features with matches revealed from the MS2 query data, defined by mass and retention time. By clicking on the side panel entry, the spectra will be loaded. The table on the bottom contains all matches revealed. Note that the library spectra will only be loaded if clicking on the table row for selection.

On the bottom, you can select if you verify the match or if it is a false positive.

If you have finalized your selection either click on the save verification button if you have uploaded the file by commandline. This will generate a new MatchedSpectra Object only containing the TRUE annotations in a *_verified.rds file.

If you have uploaded the Object though the Browse... button, please note that you should use the Select file locationbutton for stroage.