Skip to content

Commit eedbba6

Browse files
authored
Merge pull request #210 from SteffenHeu/mrm
add mrm export documentation
2 parents ae17c36 + 506159c commit eedbba6

File tree

4 files changed

+47
-0
lines changed

4 files changed

+47
-0
lines changed
15.6 KB
Loading
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Export MRMs to TSV
2+
3+
The Export MRMs to TSV module exports MRM-specific metrics to a tsv or csv table.
4+
An exemplary export is shown below:
5+
6+
![example-export](example-export.png)
7+
**Figure 1:** Example export result with [Skip missing features](#skip-missing-features) disabled.
8+
9+
## Parameters
10+
11+
#### Feature lists
12+
Select the feature lists that shall be exported.
13+
14+
#### Export file
15+
16+
Select the file to which the export should export to.
17+
18+
19+
#### Skip missing features
20+
21+
Select if the export should skip missing features, if a feature was detected in file A but not in file B. An example of the behaviour is shown in the screenshot (Figure 1) above. Here, the [Skip missing features](#skip-missing-features) option was disabled, creating an empty line for the feature of ID 43 in FILE_B. The export contains the ID of the row the feature belongs and was aligned to, but no q1 or q3 masses, no area, no height, and no RT, since the feature was not detected.
22+
23+
If the [Skip missing features](#skip-missing-features) option is enabled, this line would not exist.
24+
25+
---
26+
27+
{{ git_page_authors }}

docs/workflows/mrmworkflow/mrm-workflow.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,21 @@ Raw data is import in the usual fashion see [data import](../../module_docs/io/d
1919
The imported raw data is converted using the [MRM to scans](../../module_docs/mrm_mrmtoscans/mrm-to-scans.md)
2020
module. This creates pseudo MS1 and MS2 spectra as well as a feature list, which groups the MRM transitions
2121
by their retention time and precursor ion mass.
22+
23+
### Set quantifier masses
24+
mzmine automatically selects the quantifier mass based on the intensity of the MRM transitions and sets the most intense ion as a quantifier. If other ions shall be used as quantifiers, this module allows the selection.
25+
[mrm-set-quant-mass.md](../../module_docs/mrm_setquant/mrm-set-quant-mass.md)
26+
27+
### Smoothing in retention time dimension (optional)
28+
Depending on the LC peak shape (i.e. data noisiness), the user can perform smoothing in retention time dimension.
29+
30+
### Feature resolving
31+
Feature resolving step enables separation of co-eluting and overlapping chromatography peaks and as such is one of the pivotal steps in data preprocessing. For more detalis on the algorithm used and parameters settings, see the [Local minimum resolver](../../module_docs/featdet_resolver_local_minimum/local-minimum-resolver.md) module.
32+
33+
### Feature alignment
34+
35+
mzmine offers a specific alignment module for MRM data. The [MRM aligner](../../module_docs/align_mrm/mrm-aligner.md) takes the transitions of a feature into account and only allows alignment of features with the same transitions (in default settings). In principle, MRM feature lists can be aligned to HRMS feature lists using the [Join aligner](../../module_docs/align_join_aligner/join_aligner.md). For downsides of this procedure, see the [the MRM aligner documentation](../../module_docs/align_mrm/mrm-aligner.md#mrm-aligner)
36+
37+
---
38+
39+
{{ git_page_authors }}

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ nav:
2727
- Export to other software: module_docs/io/data-exchange-with-other-software.md
2828
- Spectral library export: module_docs/io_spectral_library_export/spectral_library_generation.md
2929
- Export scans (feature list): module_docs/io_scans_feature/export-scans-feature.md
30+
- Export MRM to TSV: module_docs/io_mrmtotsv/mrm-to-tsv.md
3031
# TODO Add feature list import/export
3132
- File merging:
3233
- Raw data files merging: module_docs/featdet_file_merging/raw-files-merging.md
@@ -148,6 +149,7 @@ nav:
148149
- Batch processing: workflows/batch_processing/batch-processing.md
149150
- Library generation: workflows/librarygeneration/library_generation.md
150151
- SIMSEF: workflows/simsef/simsef_workflow.md
152+
- MRM workflow: workflows/mrmworkflow/mrm-workflow.md
151153

152154
- Tools:
153155
- SIMSEF scheduler: module_docs/tools_simsef/simsef.md

0 commit comments

Comments
 (0)