annotate Protein_report_processing.xml @ 13:fcacb3f20451 draft default tip

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