annotate SAINT_preprocessing.xml @ 55:340cc5988c31 draft

Uploaded
author bornea
date Sat, 27 Aug 2016 21:01:12 -0400
parents 8031a47f67c6
children 5ad68d3a11cc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
1 <tool id="SAINT_preprocessing_v5" name="SAINT pre-processing">
3953103b56f9 Uploaded
bornea
parents:
diff changeset
2 <description></description>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
3 <command interpreter="python">
3953103b56f9 Uploaded
bornea
parents:
diff changeset
4 #if (str($type) == 'Scaffold'):
3953103b56f9 Uploaded
bornea
parents:
diff changeset
5 SAINT_preprocessing.py $input $preybool $fasta_db $Inter_file $Prey_file
3953103b56f9 Uploaded
bornea
parents:
diff changeset
6 "
3953103b56f9 Uploaded
bornea
parents:
diff changeset
7 #for $ba in $bait
3953103b56f9 Uploaded
bornea
parents:
diff changeset
8 ${ba.bait1}
3953103b56f9 Uploaded
bornea
parents:
diff changeset
9 ${ba.assign}
3953103b56f9 Uploaded
bornea
parents:
diff changeset
10 ${ba.T_C}
3953103b56f9 Uploaded
bornea
parents:
diff changeset
11 #end for
3953103b56f9 Uploaded
bornea
parents:
diff changeset
12 "
3953103b56f9 Uploaded
bornea
parents:
diff changeset
13 $Bait_file \$INSTALL_RUN_PATH/ $bait_bool $bait_file_in
3953103b56f9 Uploaded
bornea
parents:
diff changeset
14 #elif (str($type) == 'MaxQuant'):
3953103b56f9 Uploaded
bornea
parents:
diff changeset
15 SAINT_preprocessing_mq_pep.py $input $preybool $fasta_db $Inter_file $Prey_file
3953103b56f9 Uploaded
bornea
parents:
diff changeset
16 "
3953103b56f9 Uploaded
bornea
parents:
diff changeset
17 #for $ba in $bait
3953103b56f9 Uploaded
bornea
parents:
diff changeset
18 ${ba.bait1}
3953103b56f9 Uploaded
bornea
parents:
diff changeset
19 ${ba.assign}
3953103b56f9 Uploaded
bornea
parents:
diff changeset
20 ${ba.T_C}
3953103b56f9 Uploaded
bornea
parents:
diff changeset
21 #end for
3953103b56f9 Uploaded
bornea
parents:
diff changeset
22 "
3953103b56f9 Uploaded
bornea
parents:
diff changeset
23 $Bait_file \$INSTALL_RUN_PATH/ $bait_bool $bait_file_in
55
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
24 #elif (str($type) == 'Peptideshaker'):
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
25 Protein_report_processing.py "$input" $Bait_file $use_metric $fasta_db $preybool
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
26 "
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
27 #for $ba in $bait
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
28 ${ba.bait1}
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
29 ${ba.assign}
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
30 ${ba.T_C}
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
31 #end for
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
32 "
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
33 \$INSTALL_RUN_PATH/ $bait_bool $bait_file_in $Inter_file $Prey_file
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
34 #end if
3953103b56f9 Uploaded
bornea
parents:
diff changeset
35 </command>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
36 <requirements>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
37 <requirement type="set_environment">INSTALL_RUN_PATH</requirement>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
38 </requirements>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
39 <inputs>
55
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
40 <conditional name="type_select">
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
41 <param type="select" name="type" label="MaxQuant or Scaffold">
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
42 <option value="MaxQuant">MaxQuant</option>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
43 <option value="Scaffold">Scaffold</option>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
44 <option value="Peptideshaker">Peptideshaker</option>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
45 </param>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
46 <when value="MaxQuant">
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
47 <param format="dat" name="input" type="data" label="MaxQuant peptides Output"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
48 <param type="boolean" name="preybool" checked="true" label="Create Prey File"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
49 <param type="data" name="fasta_db" format="fasta" label="Provide Uniprot Fasta database" optional="true"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
50 <param name="bait_bool" type="boolean" checked="true" label="Are You Providing Your Own bait file?"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
51 <param type="data" format="dat" name="bait_file_in" label="Bait File" optional="true"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
52 <repeat name="bait" title="Bait Create">
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
53 <param name="bait1" type="text" size="100" label="Bait"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
54 <param name="assign" type="text" size="100" label="Group Assignment"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
55 <param name="T_C" type="boolean" checked="true" label="Is this a Control?"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
56 </repeat>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
57 <when value="Scaffold">
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
58 <param format="dat" name="input" type="data" label="Scaffold Output"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
59 <param type="boolean" name="preybool" checked="true" label="Create Prey File"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
60 <param type="data" name="fasta_db" format="fasta" label="Provide Uniprot Fasta database" optional="true"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
61 <param name="bait_bool" type="boolean" checked="true" label="Are You Providing Your Own bait file?"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
62 <param type="data" format="dat" name="bait_file_in" label="Bait File" optional="true"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
63 <repeat name="bait" title="Bait Create">
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
64 <param name="bait1" type="text" size="100" label="Bait"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
65 <param name="assign" type="text" size="100" label="Group Assignment"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
66 <param name="T_C" type="boolean" checked="true" label="Is this a Control?"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
67 </repeat>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
68 </when>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
69 <when value="Peptideshaker">
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
70 <param format="dat" name="input" type="data" label="Peptideshaker Output" multiple="true"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
71 <param type="select" name="use_metric" label="Select Report File Value for Quantification">
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
72 <option value="Validated_Peptides">#Validated Peptides</option>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
73 <option value="Peptides">#Peptides</option>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
74 <option value="Unique">#Unique</option>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
75 <option value="Validated_PSMs">#Validated PSMs</option>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
76 <option value="PSMs">#PSMs</option>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
77 </param>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
78 <param type="boolean" name="preybool" checked="true" label="Create Prey File"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
79 <param type="data" name="fasta_db" format="fasta" label="Provide Uniprot Fasta database" optional="true"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
80 <param name="bait_bool" type="boolean" checked="true" label="Are You Providing Your Own bait file?"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
81 <param type="data" format="dat" name="bait_file_in" label="Bait File" optional="true"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
82 <repeat name="bait" title="Bait Create">
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
83 <param name="bait1" type="text" size="100" label="Bait"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
84 <param name="assign" type="text" size="100" label="Group Assignment"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
85 <param name="T_C" type="boolean" checked="true" label="Is this a Control?"/>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
86 </repeat>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
87 </when>
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
88 </conditional>
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
89 </inputs>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
90 <outputs>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
91 <data format="txt" name="Inter_file" label="Inter File"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
92 <data format="txt" name="Prey_file" label="Prey File" />
3953103b56f9 Uploaded
bornea
parents:
diff changeset
93 <data format="txt" name="Bait_file" label="Bait File" />
3953103b56f9 Uploaded
bornea
parents:
diff changeset
94 </outputs>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
95 <stdio>
52
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
96 <regex match="Error: bad bait"
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
97 source="stdout"
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
98 level="fatal"
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
99 description="Error: bad bait"/>
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
100 <regex match="IOError: [Errno 2] No such file or directory: './tukeys_output.txt'"
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
101 source="stderr"
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
102 level="fatal"
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
103 description="Error: Scaffold/MaxQuant mismatch. Check job settings."/>
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
104 <regex match="bait_temp_file = open(sys.argv[10], 'r')"
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
105 source="stderr"
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
106 level="fatal"
8031a47f67c6 Uploaded
bornea
parents: 27
diff changeset
107 description="Error: Bait create settings mismatch. Check job settings."/>
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
108 <regex match="Error|error"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
109 source="stdout"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
110 level="fatal"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
111 description="Unknown error"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
112 <regex match="Error|error"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
113 source="stderr"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
114 level="fatal"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
115 description="Unknown error"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
116 </stdio>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
117
3953103b56f9 Uploaded
bornea
parents:
diff changeset
118 <tests>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
119 <test>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
120 <param name="input" value="fa_gc_content_input.fa"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
121 <output name="out_file1" file="fa_gc_content_output.txt"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
122 </test>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
123 </tests>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
124 <help>
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
125 Pre-Processing
25
9a110e634afe Uploaded
bornea
parents: 24
diff changeset
126 ^^^^^^^^^^^^^^
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
127
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
128 This tool will read in a Scaffold *Samples Report* file (tab-delimited
55
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
129 txt file), multiple Peptideshaker *Protein Report* files or a MaxQuant
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
130 *peptides.txt* file and process them to generate a *Bait File, Prey
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
131 File,* and *Inter File* for SAINTexpress analysis.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
132
25
9a110e634afe Uploaded
bornea
parents: 24
diff changeset
133 --------------
9a110e634afe Uploaded
bornea
parents: 24
diff changeset
134
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
135 **1) MaxQuant or Scaffold**
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
136
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
137 APOSTL is able to recognize either a Scaffold *Samples Report* file
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
138 (tab-delimited txt file) or the *peptides.txt* file output in the
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
139 MaxQuant *txt* output folder. No modifications should be made to these
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
140 files. Please designate which one is being provided.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
141
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
142 **2) Scaffold or MaxQuant File Input**
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
143
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
144 Select the corresponding *Samples Report* or *peptides.txt* here.
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
145
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
146 **3) Create Prey File**
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
147
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
148 Select whether or not you would like APOSTL to generate a prey file.
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
149
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
150 When making a prey file, APOSTL queries a user provided FASTA database
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
151 (see below) in order to extract protein amino acid lengths and gene
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
152 names. This may take several minutes depending on your computer and if
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
153 your Galaxy distribution is cluster enabled. Some users may want to run
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
154 SAINTexpress using the same data set while changing which baits are
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
155 considered test or control. It is useful to toggle **Create Prey File**
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
156 off in order to save time by circumventing this step as the same prey
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
157 file can be used for both SAINTexpress runs.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
158
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
159 **4) Provide Uniprot FASTA database**
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
160
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
161 Please specify a FASTA file containing the protein sequence. You can
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
162 download the latest release of Uniprot's reviewed sequences (Swiss-Prot)
24
85c19ee579d6 Uploaded
bornea
parents: 23
diff changeset
163 http://www.uniprot.org/downloads. For computing efficiency,
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
164 please limit your FASTA file to your species of interest. It is
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
165 generally advised to use the same FASTA database that was used for your
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
166 database searches during peptide and protein ID.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
167
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
168 **5) Are You Providing Your Own Bait File?**
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
169
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
170 Users have two options for providing a *Bait* file. If you would like to
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
171 create your own *Bait* file, select Yes and designate the file below. If
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
172 you would like to use the **Bait Create** tool to create a *Bait* file
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
173 within Galaxy, please select No and proceed to the **Bait Create** tool.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
174
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
175 **6) Bait File**
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
176
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
177 If you selected Yes above, please specify the *Bait* file you would like
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
178 to provide. If you selected No above, ignore this argument and proceed
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
179 to the **Bait Create** tool.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
180
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
181 **Note:** Individual bait names must match to the sample names
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
182 within your Scaffold or MaxQuant output exactly and must contain no
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
183 whitespace characters (e.g. spaces) or dashes.
55
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
184
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
185 **Note:** When using Peptideshaker output the baits in the baitfile
340cc5988c31 Uploaded
bornea
parents: 52
diff changeset
186 need to be in the same order as the files selected.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
187
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
188 **7) Bait Create**
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
189
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
190 Using the **Bait Create** tool, you can create your *bait.txt* file.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
191
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
192 **Note:** Individual bait names must match to the sample names
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
193 within your Scaffold or MaxQuant output exactly and must contain no
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
194 whitespace characters (e.g. spaces) or dashes.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
195
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
196 APOSTL uses this bait file to find the user's baits of interest within a
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
197 *Samples Report* or *peptides.txt* file and when preparing the
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
198 *inter.txt* file.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
199
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
200 --------------
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
201
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
202 Once your parameters have been finalized, please press the Execute
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
203 button to start processing. This may take a few minutes. Once your
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
204 process has been completed, you will see your *Bait File, Prey File,*
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
205 and *Inter File* on the right hand side of your panel highlighted in
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
206 green.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
207 </help>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
208 </tool>