annotate SAINT_preprocessing.xml @ 20:0ac97a6298c2 draft

Uploaded
author bornea
date Thu, 14 Apr 2016 17:24:05 -0400
parents 3953103b56f9
children d9592cc1df99
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>
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
74 # Pre-Processing
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
75
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
76 * * *
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
77
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
78 This tool will read in a Scaffold _Samples Report_ file (tab-delimited txt file) or a MaxQuant _peptides.txt_ file and process them to generate a _Bait File, Prey File,_ and _Inter File_ for SAINTexpress analysis.
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
79
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
80 #### 1) MaxQuant or Scaffold
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
81
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
82 APOSTL is able to recognize either a Scaffold _Samples Report_ file (tab-delimited txt file) or the _peptides.txt_ file output in the MaxQuant _txt_ output folder. No modifications should be made to these files. Please designate which one is being provided.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
83
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
84 #### 2) Scaffold or MaxQuant File Input
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
85
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
86 Select the corresponding _Samples Report_ or _peptides.txt_ here.
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
87
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
88 #### 3) Create Prey File
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
89
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
90 Select whether or not you would like APOSTL to generate a prey file.
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
91
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
92 When making a prey file, APOSTL queries a user provided FASTA database (see below) in order to extract protein amino acid lengths and gene names. This may take several minutes depending on your computer and if your Galaxy distribution is cluster enabled. Some users may want to run SAINTexpress using the same data set while changing which baits are considered test or control. It is useful to toggle **Create Prey File** off in order to save time by circumventing this step as the same prey file can be used for both SAINTexpress runs.
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
93
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
94 #### 4) Provide Uniprot FASTA database
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
95
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
96 Please specify a FASTA file containing the protein sequence. You can download the latest release of Uniprot's reviewed sequences (Swiss-Prot) [here](http://www.uniprot.org/downloads). For computing efficiency, please limit your FASTA file to your species of interest. It is generally advised to use the same FASTA database that was used for your database searches during peptide and protein ID.
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
97
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
98 #### 5) Are You Providing Your Own Bait File?
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
99
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
100 Users have two options for providing a _Bait_ file. If you would like to create your own _Bait_ file, select <kbd>Yes</kbd> and designate the file below. If you would like to use the **Bait Create** tool to create a _Bait_ file within Galaxy, please select <kbd>No</kbd> and proceed to the **Bait Create** tool.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
101
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
102 #### 6) Bait File
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
103
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
104 If you selected <kbd>Yes</kbd> above, please specify the _Bait_ file you would like to provide. If you selected <kbd>No</kbd> above, ignore this argument and proceed to the **Bait Create** tool.
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
105
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
106 > **Note:** Individual bait names must match to the sample names within your Scaffold or MaxQuant output exactly and must contain no whitespace characters (e.g. spaces) or dashes.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
107
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
108 #### 7) Bait Create
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
109
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
110 Using the **Bait Create** tool, you can create your _bait.txt_ file.
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
111
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
112 > **Note:** Individual bait names must match to the sample names within your Scaffold or MaxQuant output exactly and must contain no whitespace characters (e.g. spaces) or dashes.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
113
20
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
114 APOSTL uses this bait file to find the user's baits of interest within a _Samples Report_ or _peptides.txt_ file and when preparing the _inter.txt_ file.
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
115
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
116 * * *
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
117
0ac97a6298c2 Uploaded
bornea
parents: 5
diff changeset
118 Once your parameters have been finalized, please press the <kbd>Execute</kbd> button to start processing. This may take a few minutes. Once your process has been completed, you will see your _Bait File, Prey File,_ and _Inter File_ on the right hand side of your panel highlighted in green.
5
3953103b56f9 Uploaded
bornea
parents:
diff changeset
119 </help>
3953103b56f9 Uploaded
bornea
parents:
diff changeset
120 </tool>