annotate SAINT_preprocessing.xml @ 38:a7a479d8cbf8 draft

Uploaded
author bornea
date Thu, 19 May 2016 10:28:23 -0400
parents 2d78642361c3
children 8031a47f67c6
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
3953103b56f9 Uploaded
bornea
parents:
diff changeset
24 #end if
3953103b56f9 Uploaded
bornea
parents:
diff changeset
25 </command>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
26 <requirements>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
27 <requirement type="set_environment">INSTALL_RUN_PATH</requirement>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
28 <requirement type="package" version="3.2.1">package_r_3_2_1</requirement>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
29 </requirements>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
30 <inputs>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
31 <param type="select" name="type" label="MaxQuant or Scaffold">
3953103b56f9 Uploaded
bornea
parents:
diff changeset
32 <option value="MaxQuant">MaxQuant</option>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
33 <option value="Scaffold">Scaffold</option>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
34 </param>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
35 <param format="dat" name="input" type="data" label="Scaffold or MaxQuant proteinGroup Output"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
36 <param type="boolean" name="preybool" checked="true" label="Create Prey File"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
37 <param type="data" name="fasta_db" format="fasta" label="Provide Uniprot Fasta database" optional="true"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
38 <param name="bait_bool" type="boolean" checked="true" label="Are You Providing Your Own bait file?"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
39 <param type="data" format="dat" name="bait_file_in" label="Bait File" optional="true"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
40 <repeat name="bait" title="Bait Create">
3953103b56f9 Uploaded
bornea
parents:
diff changeset
41 <param name="bait1" type="text" size="100" label="Bait"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
42 <param name="assign" type="text" size="100" label="Group Assignment"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
43 <param name="T_C" type="boolean" checked="true" label="Is this a Control?"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
44 </repeat>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
45
3953103b56f9 Uploaded
bornea
parents:
diff changeset
46 </inputs>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
47 <outputs>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
48 <data format="txt" name="Inter_file" label="Inter File"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
49 <data format="txt" name="Prey_file" label="Prey File" />
3953103b56f9 Uploaded
bornea
parents:
diff changeset
50 <data format="txt" name="Bait_file" label="Bait File" />
3953103b56f9 Uploaded
bornea
parents:
diff changeset
51 </outputs>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
52 <stdio>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
53 <regex match="Error|error"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
54 source="stdout"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
55 level="fatal"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
56 description="Unknown error"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
57 <regex match="Error|error"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
58 source="stderr"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
59 level="fatal"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
60 description="Unknown error"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
61 <regex match="Error: bad bait"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
62 source="stdout"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
63 level="fatal"
3953103b56f9 Uploaded
bornea
parents:
diff changeset
64 description="Error: bad bait"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
65 </stdio>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
66
3953103b56f9 Uploaded
bornea
parents:
diff changeset
67 <tests>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
68 <test>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
69 <param name="input" value="fa_gc_content_input.fa"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
70 <output name="out_file1" file="fa_gc_content_output.txt"/>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
71 </test>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
72 </tests>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
73 <help>
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
74 Pre-Processing
25
9a110e634afe Uploaded
bornea
parents: 24
diff changeset
75 ^^^^^^^^^^^^^^
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
76
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
77 This tool will read in a Scaffold *Samples Report* file (tab-delimited
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
78 txt file) or a MaxQuant *peptides.txt* file and process them to generate
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
79 a *Bait File, Prey File,* and *Inter File* for SAINTexpress analysis.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
80
25
9a110e634afe Uploaded
bornea
parents: 24
diff changeset
81 --------------
9a110e634afe Uploaded
bornea
parents: 24
diff changeset
82
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
83 **1) MaxQuant or Scaffold**
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
84
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
85 APOSTL is able to recognize either a Scaffold *Samples Report* file
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
86 (tab-delimited txt file) or the *peptides.txt* file output in the
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
87 MaxQuant *txt* output folder. No modifications should be made to these
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
88 files. Please designate which one is being provided.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
89
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
90 **2) Scaffold or MaxQuant File Input**
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
91
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
92 Select the corresponding *Samples Report* or *peptides.txt* here.
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
93
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
94 **3) Create Prey File**
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
95
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
96 Select whether or not you would like APOSTL to generate a prey file.
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
97
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
98 When making a prey file, APOSTL queries a user provided FASTA database
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
99 (see below) in order to extract protein amino acid lengths and gene
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
100 names. This may take several minutes depending on your computer and if
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
101 your Galaxy distribution is cluster enabled. Some users may want to run
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
102 SAINTexpress using the same data set while changing which baits are
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
103 considered test or control. It is useful to toggle **Create Prey File**
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
104 off in order to save time by circumventing this step as the same prey
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
105 file can be used for both SAINTexpress runs.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
106
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
107 **4) Provide Uniprot FASTA database**
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
108
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
109 Please specify a FASTA file containing the protein sequence. You can
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
110 download the latest release of Uniprot's reviewed sequences (Swiss-Prot)
24
85c19ee579d6 Uploaded
bornea
parents: 23
diff changeset
111 http://www.uniprot.org/downloads. For computing efficiency,
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
112 please limit your FASTA file to your species of interest. It is
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
113 generally advised to use the same FASTA database that was used for your
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
114 database searches during peptide and protein ID.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
115
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
116 **5) Are You Providing Your Own Bait File?**
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
117
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
118 Users have two options for providing a *Bait* file. If you would like to
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
119 create your own *Bait* file, select Yes and designate the file below. If
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
120 you would like to use the **Bait Create** tool to create a *Bait* file
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
121 within Galaxy, please select No and proceed to the **Bait Create** tool.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
122
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
123 **6) Bait File**
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
124
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
125 If you selected Yes above, please specify the *Bait* file you would like
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
126 to provide. If you selected No above, ignore this argument and proceed
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
127 to the **Bait Create** tool.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
128
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
129 **Note:** Individual bait names must match to the sample names
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
130 within your Scaffold or MaxQuant output exactly and must contain no
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
131 whitespace characters (e.g. spaces) or dashes.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
132
27
2d78642361c3 Uploaded
bornea
parents: 26
diff changeset
133 **7) Bait Create**
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
134
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
135 Using the **Bait Create** tool, you can create your *bait.txt* file.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
136
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
137 **Note:** Individual bait names must match to the sample names
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
138 within your Scaffold or MaxQuant output exactly and must contain no
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
139 whitespace characters (e.g. spaces) or dashes.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
140
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
141 APOSTL uses this bait file to find the user's baits of interest within a
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
142 *Samples Report* or *peptides.txt* file and when preparing the
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
143 *inter.txt* file.
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
144
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
145 --------------
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
146
21
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
147 Once your parameters have been finalized, please press the Execute
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
148 button to start processing. This may take a few minutes. Once your
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
149 process has been completed, you will see your *Bait File, Prey File,*
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
150 and *Inter File* on the right hand side of your panel highlighted in
d9592cc1df99 Uploaded
bornea
parents: 20
diff changeset
151 green.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
152 </help>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
153 </tool>