annotate MS2snoop.xml @ 4:8f361d405d8d draft default tip

" master branch Updating"
author lain
date Wed, 20 Apr 2022 14:07:30 +0000
parents c94a5822d315
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
67733206be53 " master branch Updating"
lain
parents:
diff changeset
1 <tool id="MS2snoop" name="MS2 Snoop" version="1.0.0">
67733206be53 " master branch Updating"
lain
parents:
diff changeset
2 <description>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
3 Extraction des spectres MS1 et adduits associées + Extraction +
67733206be53 " master branch Updating"
lain
parents:
diff changeset
4 nettoyage automatisé des spectres MS2 Extraction des métadonnées
67733206be53 " master branch Updating"
lain
parents:
diff changeset
5 des fichiers RAW Export en fichier idéalement en JSON
67733206be53 " master branch Updating"
lain
parents:
diff changeset
6 </description>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
7
67733206be53 " master branch Updating"
lain
parents:
diff changeset
8 <requirements>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
9 <requirement type="package">r-base</requirement>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
10 <requirement type="package">r-optparse</requirement>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
11 </requirements>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
12
67733206be53 " master branch Updating"
lain
parents:
diff changeset
13 <command><![CDATA[
67733206be53 " master branch Updating"
lain
parents:
diff changeset
14 Rscript '$__tool_directory__/MS2snoop.R'
67733206be53 " master branch Updating"
lain
parents:
diff changeset
15 -o $frag_result_txt
67733206be53 " master branch Updating"
lain
parents:
diff changeset
16 -c $compound_txt
67733206be53 " master branch Updating"
lain
parents:
diff changeset
17 -f $peaklist_frag_tsv
67733206be53 " master branch Updating"
lain
parents:
diff changeset
18 -p $peaklist_preco_tsv
67733206be53 " master branch Updating"
lain
parents:
diff changeset
19 --tolmz $tolmz
67733206be53 " master branch Updating"
lain
parents:
diff changeset
20 --tolrt $tolrt
67733206be53 " master branch Updating"
lain
parents:
diff changeset
21 --seuil_ra $seuil_ra
67733206be53 " master branch Updating"
lain
parents:
diff changeset
22 --mzdecimal $mzdecimal
67733206be53 " master branch Updating"
lain
parents:
diff changeset
23 --r_threshold $r_threshold
67733206be53 " master branch Updating"
lain
parents:
diff changeset
24 --min_number_scan $min_number_scan
67733206be53 " master branch Updating"
lain
parents:
diff changeset
25 ;
67733206be53 " master branch Updating"
lain
parents:
diff changeset
26 ]]></command>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
27
67733206be53 " master branch Updating"
lain
parents:
diff changeset
28 <inputs>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
29 <param type="data" name="compound_txt" label="compounds_pos.txt" />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
30 <param type="data" name="peaklist_frag_tsv" label="peaklist_fragments.tsv" />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
31 <param type="data" name="peaklist_preco_tsv" label="peaklist_precursors.tsv" />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
32 <param name="tolmz" type="float" value="0.01" label="MZ Tolerence" />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
33 <param name="tolrt" type="integer" value="20" label="RT Telerence" />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
34 <param name="seuil_ra" type="float" value="0.05" label="r pearson correlation threshold between precursor and fragment absolute intensity" />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
35 <param name="mzdecimal" type="integer" value="0" label="nb decimal for mz" />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
36 <param name="r_threshold" type="float" value="0.85" label="fragment absolute intensity" />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
37 <param
67733206be53 " master branch Updating"
lain
parents:
diff changeset
38 name="min_number_scan"
67733206be53 " master branch Updating"
lain
parents:
diff changeset
39 type="integer"
67733206be53 " master branch Updating"
lain
parents:
diff changeset
40 value="8"
67733206be53 " master branch Updating"
lain
parents:
diff changeset
41 label="Present in at least X scan"
67733206be53 " master branch Updating"
lain
parents:
diff changeset
42 help="fragments are kept if they are found in a minimum number of scans"
67733206be53 " master branch Updating"
lain
parents:
diff changeset
43 />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
44 </inputs>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
45 <outputs>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
46 <data name="frag_result_txt" format="txt" label="compound_fragments_result.txt" />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
47 </outputs>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
48 <tests>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
49 <test>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
50 <param name="compound_txt" value="compounds_pos.txt"/>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
51 <param name="peaklist_frag_tsv" value="peaklist_fragments.tsv"/>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
52 <param name="peaklist_preco_tsv" value="peaklist_precursors.tsv"/>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
53 <output name="frag_result_txt" file="compound_fragments_result.txt" />
67733206be53 " master branch Updating"
lain
parents:
diff changeset
54 </test>
67733206be53 " master branch Updating"
lain
parents:
diff changeset
55 </tests>
3
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
56
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
57 <help><![CDATA[
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
58
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
59 .. class:: infomark
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
60 **Authors** Jean-Francois Martin (jean-francois.martin@inrae.fr), Lain Pavot (lain.pavot@inrae.fr), Kevin Wagner (kevin.wagner@inrae.fr)
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
61 .. class:: infomark
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
62 ---------------------------------------------------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
63
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
64 ==============
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
65 MS2 validation
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
66 ==============
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
67
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
68 -----------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
69 Description
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
70 -----------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
71
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
72 MS2snoop use results of msPurity to find spectra of standards listed in a compounds file.
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
73 Check the fragments and precursor using correlation of among the different scans of fragments
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
74
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
75 -----------------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
76 Workflow position
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
77 -----------------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
78
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
79 **Upstream tools**
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
80 ========================= ================= ======= =========
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
81 Name output file format parameter
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
82 ========================= ================= ======= =========
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
83 msPurity.purityA NA TSV NA
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
84 msPurity.frag4feature NA TSV NA
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
85 ========================= ================= ======= =========
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
86 **Downstream tools**
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
87 ========================= ================= ======= =========
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
88 Name output file format parameter
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
89 ========================= ================= ======= =========
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
90 NA NA NA NA
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
91 ========================= ================= ======= =========
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
92
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
93 -----------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
94 Input files
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
95 -----------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
96
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
97 +----------------------------------------------+------------+
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
98 | Parameter : num + label | Format |
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
99 +===========================+==================+============+
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
100 | Input from msPurity Precursor | TSV |
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
101 | Input from msPurity fragment | TSV |
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
102 | Input compounds file to search in precursor | |
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
103 | and fragment (Name + m/z + ret Time) | TSV |
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
104 +----------------------------------------------+------------+
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
105
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
106
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
107 ----------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
108 Parameters
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
109 ----------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
110
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
111 msPurity.purityA output TSV file
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
112 msPurity.frag4feature output TSV file
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
113 Compounds file
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
114 | A TSV TXT file with a list of compounds with at least 3 columns :
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
115 | col1=Name of molecule, col2=m/z, col3=retention time
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
116 tolerance for mz(dalton) rt(seconds) to match the standard in the compounds file with the precursor MSpurity files
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
117 | tolmz <- 0.01
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
118 | tolrt <- 20
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
119 relative intensity threshold
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
120 | seuil_ra = 0.05
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
121 nb decimal for mz
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
122 | mzdecimal <- 0
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
123 r pearson correlation threshold between precursor and fragment absolute intensity
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
124 | r_threshold <- 0.85
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
125 fragments are kept if there are found in a minimum number of scans
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
126 | minNumberScan <- 8
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
127
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
128 ------------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
129 Output files
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
130 ------------
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
131
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
132 compound_fragments_result.tsv
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
133 | tabular output
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
134 | Array with p rows (corresponding to the fragments for the different compounds of the compounds file)
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
135 | Last column "corvalid" is a boolean for validated fragments
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
136 processing_file.pdf
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
137 | pdf output
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
138 | For each compound of the compounds file, Graph of the all fragments with parents (or most intense peak if parent is not detected in the fragments. At the end the pdf file a graph of the spectra with validated fragments.
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
139
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
140 ]]></help>
c94a5822d315 " master branch Updating"
lain
parents: 0
diff changeset
141
0
67733206be53 " master branch Updating"
lain
parents:
diff changeset
142 </tool>