Skip to content
Open
Show file tree
Hide file tree
Changes from 36 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
4c272cd
[DOC] - removing sphinx-tabs
Oct 20, 2021
fa2b2c8
[DOC] - fixing CLI code blocks and adding docs for smartpeak-cli cont…
Oct 20, 2021
f66d3a0
[DOC] - switch to latest->develop
Oct 20, 2021
76994d3
[ASSETS] - updated containerisation assets
Oct 20, 2021
2a032f8
[ASSETS] - updated containerisation assets
Oct 20, 2021
4bcb6c6
[DOC] - update doc badge URL
Oct 21, 2021
91ca5e5
[DOC] - updating SmartPeal Features from fix/select_dilution
Oct 22, 2021
8cbaeac
Merge branch 'develop' into fix/aut1035
Nov 1, 2021
e217e60
[DOC] - updating RtD structure
Nov 4, 2021
72d5e5b
Merge branch 'fix/aut1035' of https://github.com/AutoFlowResearch/Sma…
Nov 4, 2021
b7224f5
[DOC] - Author/Maintainer updates
Nov 6, 2021
84f763e
[DOC] - init waklthroughs sections
Nov 9, 2021
b47151e
Merge branch 'develop' into feat/aut783
Nov 9, 2021
a26db7a
[DOC] - HPLC_UV_Standards/Unknowns
Nov 13, 2021
04d9785
[DOC] - HPLC_UV_Standards/Unknowns
Nov 13, 2021
a20a760
[DOC] - HPLC_UV_Standards/Unknowns
Nov 13, 2021
01ee079
[DOC] - removing 6500 assays
Nov 18, 2021
ba539ff
[DOC] - organising csv samples into tables I
Nov 19, 2021
7f7e24f
[DOC] - dataset structure
Nov 23, 2021
78e1cb9
[DOC] - HPLC UV walkthrough
Nov 23, 2021
dc4c282
[DOC] - HPLC UV walkthrough cont.
Nov 25, 2021
8c9ffbc
[DOC] - minor additions
Nov 26, 2021
7f082f3
[DOC] - FIAMS FullScan Unknowns walkthrough
Nov 29, 2021
bd084ea
[DOC] - FIAMS FullScan Unknowns walkthrough cont.
Nov 30, 2021
4251d95
Merge branch 'develop' into feat/aut790
Nov 30, 2021
f29c4e9
[DOC] - minor changes
Nov 30, 2021
7bb02fe
[DOC] - FIAMS FullScan Unknowns walkthrough cont.
Nov 30, 2021
afa6992
[DOC] - FIAMS FullScan Unknowns walkthrough cont.
Dec 2, 2021
13301ef
[DOC] - adding files to FIAMS FullScan Unknowns
Dec 9, 2021
442ddb3
[DOC] - structural changes to the tutorials section
Dec 20, 2021
522a9a6
[API] - update to newer OpenMS RangeManager API
Dec 20, 2021
5e375c1
[DOC] - Walkthrough: Targeted flux analysis with LC-MS/MS Agilent Lip…
Dec 21, 2021
3246f66
[DOC] - Walkthrough: Targeted flux analysis with GC-MS SIM Agilent
Dec 21, 2021
86e9e97
Merge branch 'develop' into feat/aut789
Dec 21, 2021
24dbbdb
[DOC] - minor changes
Dec 27, 2021
6cd6e38
[DOC] - minor changes
Dec 27, 2021
d97549a
[DOC] - minor changes
Dec 30, 2021
42a2415
Merge branch 'develop' into feat/aut789
Dec 30, 2021
a420a46
Merge branch 'develop' into feat/aut789
Jan 16, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/guide/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ Tutorials & Demos
This section covers a breadth of walkthroughs using different datasets and analytical techniques.


* :doc:`tutorials/Structure_of_Data_Sets`.

* :doc:`tutorials/Targeted_quantitation_with_HPLC_data`.

* :doc:`tutorials/Non-targeted_FIA-MS_analysis_with_Thermo_Orbitrap`.
* :doc:`tutorials/Non-targeted_FIA-MS_analysis_with_Thermo_Orbitrap`.

* :doc:`tutorials/Targeted_flux_analysis_with_LC-MSMS_Agilent_Lipidomics`.

* :doc:`tutorials/Targeted_flux_analysis_with_GC-MS_SIM_Agilent`.

Original file line number Diff line number Diff line change
@@ -1,2 +1,97 @@
Targeted flux analysis with GC-MS SIM Agilent
---------------------------------------------
---------------------------------------------

This tutorial walks you through the workflow for analyzing targeted flux analysis
using SIM GC-MS/MS data starting from input file generation, to processing the data in SmartPeak,
to reviewing the data in SmartPeak, to reporting the results for later use.

Objectives
~~~~~~~~~~

#. Obtaining the SOP for the workflow.
#. Choosing a data set for demonstrating the workflow.
#. Creating an optimized SmartPeak input templates for running the workflow.

The Workflows include
~~~~~~~~~~~~~~~~~~~~~

#. Processing Unknowns
#. Reviewing the results

Steps
~~~~~

The tutorial includes the following steps :

#. Setting up the input files

The data set used can be found here
`GCMS SIM Unknowns <https://github.com/AutoFlowResearch/SmartPeak/tree/develop/src/examples/data/GCMS_SIM_Unknowns>`_.

The dataset includes a ``parameters.csv`` file containing parameter settings for ``MRMFeatureFinderScoring``, ``MRMFeatureSelector``,
``MRMFeatureValidator``, ``ReferenceDataMethods``, ``MRMFeatureSelector``, ``MRMMapping``, ``FeaturePlotter``, ``SequenceSegmentPlotter``
and ``AbsoluteQuantitation``.


#. Defining the workflow in SmartPeak

For the targeted flux analysis via SIM GCMS, the following steps are saved
into the ``workflow.csv`` file. Alternatively, steps can be replaced,
added or deleted direclty from SmartPeakGUI within the "workflow" tap in the right pane.
A detailed explanation of each command step
can be found in :ref:`Workflow Commands`.

* LOAD_RAW_DATA
* MAP_CHROMATOGRAMS
* EXTRACT_CHROMATOGRAM_WINDOWS
* ZERO_CHROMATOGRAM_BASELINE
* PICK_MRM_FEATURES
* QUANTIFY_FEATURES
* CHECK_FEATURES
* SELECT_FEATURES
* CALCULATE_MDVS
* ISOTOPIC_CORRECTIONS
* CALCULATE_MDV_ACCURACIES
* STORE_FEATURES

The workflow pipeline is initialized by loading the raw data followed
by mapping the chromatograms to the loaded set of transitions. Once done,
chromatogram windows will be extracted based on the componentFeatureFilter
parameters, then for normalizing the lowest chromatogram intensity to zero. The
next step in the pipeline is to execute the peak picking routine on the SRM/MRM
features followed by applying a calibration model to each transition as defined
in the quantitationMethods parameters. Transitions and transition groups are
flagged and scored per user pre-defined criteria, then the peak selection/
alignment algorithms is executed. Mass distribution vectors can then be
calculated followed by isotopic corrections and comparing the MDVs to the
theoretical values. As the final step in the workflow, the features
for the sample group is stored to disk as a ``featureXML`` files.

To plot the intensities over time for given injections and transitions, view the "chromatogram" from the "view" menu
then select the injections and transitions to plot from their respective tabs on the left. The following shows the chromatogram
for one injection using Lactate, PEP and Succinate transitions and their intensity differences over time.

.. image:: ../images/gcms_sim_unknowns_chromatogram.png

The features can also be plotted as a heatmap, under "view" select "Features (heatmap)" then select the "logSN"
feature to display transition groups as a heatmap and compare the values from the same injection as shown below:

.. image:: ../../images/gcms_sim_unknowns_heatmap.png

#. Reporting the results

To export the results, select "Report" from the "Actions" which will show the
"Create Report" window:

.. image:: ../../images/lcms_targeted_flux_exports.png

Based in the data you wish to export, select the desired "Sample types" from the left pane
and select the "Metadata" from the right pane then click on one of the buttons below to create
the report with the selected items in the csv format.

More details on exporting the results can be found in :ref:`Export report`.

The resulting ``featureXML`` and ``mzTab`` are saved in the features folder. ``featureXML`` files describe the spectra
data for a given injection sample which includes a list of features with a set of ``UserParam`` for each feature such as
``PeptideRef``, ``native_id`` and ``scan_polarity``.

Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Targeted flux analysis with LC-MS/MS Agilent Lipidomics
-------------------------------------------------------
-------------------------------------------------------

Binary file added images/gcms_sim_unknowns_chromatogram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/gcms_sim_unknowns_heatmap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/lcms_targeted_flux_chromatogram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/lcms_targeted_flux_exports.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/lcms_targeted_flux_spectra.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions src/examples/data/GCMS_SIM_Unknowns/parameters.csv
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,7 @@ AbsoluteQuantitation,use_chauvenet,string,FALSE,TRUE,,Whether to only remove out
AbsoluteQuantitation,optimization_method,string,iterative,iterative,,Calibrator optimization method to find the best set of calibration points for each method.,TRUE,,
SequenceSegmentPlotter,export_format,string,pdf,pdf,,The export format of the plot,TRUE,,
SequenceSegmentPlotter,annotate_features,bool,TRUE,,,Annotate peaks with features,TRUE,,
CalculateMDVs,mass_intensity_type,string,norm_sum,,,,TRUE,,
CalculateMDVs,feature_name,string,peak_apex_int,,,,TRUE,,
IsotopicCorrections,correction_matrix_agent,string,TBDMS,,,,TRUE,,
CalculateMDVAccuracies,feature_name,string,peak_apex_int,,,,TRUE,,
Loading