annotate protein_prophet.xml @ 17:868e75fc0f70 draft default tip

Export XML_ONLY variable
author iracooke
date Mon, 26 Oct 2015 22:04:43 -0400
parents 0746a2ae9e04
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
1 <tool id="proteomics_search_protein_prophet_1" name="Protein Prophet" version="1.1.1">
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
2 <description>Calculate Protein Prophet statistics on search results</description>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
3 <requirements>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
4 <container type="docker">iracooke/protk-1.4.3</container>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
5 <requirement type="package" version="1.4.3">protk</requirement>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
6 <requirement type="package" version="4.8.0">trans_proteomic_pipeline</requirement>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
7 </requirements>
12
4c66453a168e Uploaded
iracooke
parents:
diff changeset
8
15
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
9 <command>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
10 protein_prophet.rb
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
11 --galaxy
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
12
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
13 #for $input_file in $input_files:
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
14 ${input_file}
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
15 #end for
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
16
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
17 -o protein_prophet_results.prot.xml
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
18 -r
12
4c66453a168e Uploaded
iracooke
parents:
diff changeset
19
15
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
20 $iproph
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
21 $nooccam
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
22 $groupwts
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
23 $normprotlen
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
24 $logprobs
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
25 $confem
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
26 $allpeps
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
27 $unmapped
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
28 $instances
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
29 $delude
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
30 --minprob=$minprob
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
31 --minindep=$minindep
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
32 </command>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
33 <inputs>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
34 <param name="input_files" type="data" format="peptideprophet_pepxml,interprophet_pepxml" multiple="true" label="Peptide Prophet Results" help="These files will typically be outputs from peptide prophet or interprophet"/>
12
4c66453a168e Uploaded
iracooke
parents:
diff changeset
35
15
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
36 <param name="iproph" selected="true" type="boolean" label="Inputs are from iProphet" truevalue="--iprophet-input" falsevalue=""/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
37 <param name="nooccam" type="boolean" label="Don't apply Occam's razor" help="When selected no attempt will be made to derive the simplest protein list explaining observed peptides" truevalue="--no-occam" falsevalue=""/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
38 <param name="groupwts" type="boolean" label="Use group weights" help="Check peptide's total weight (rather than actual weight) in the Protein Group against the threshold" truevalue="--group-wts" falsevalue=""/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
39 <param name="normprotlen" type="boolean" label="Normalize NSP using Protein Length" truevalue="--norm-protlen" falsevalue=""/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
40 <param name="logprobs" type="boolean" label="Use the log of probability in the confidence calculations" truevalue="--log-prob" falsevalue=""/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
41 <param name="confem" type="boolean" label="Use the EM to compute probability given the confidenct" truevalue="--confem" falsevalue=""/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
42 <param name="allpeps" type="boolean" label="Consider all possible peptides in the database in the confidence model" truevalue="--allpeps" falsevalue=""/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
43 <param name="unmapped" type="boolean" label="Report results for unmapped proteins" truevalue="--unmapped" falsevalue=""/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
44 <param name="instances" type="boolean" label="Use Expected Number of Ion Instances to adjust the peptide probabilities prior to NSP adjustment" truevalue="--instances" falsevalue=""/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
45 <param name="delude" type="boolean" label="Do NOT use peptide degeneracy information when assessing proteins" truevalue="--delude" falsevalue=""/>
12
4c66453a168e Uploaded
iracooke
parents:
diff changeset
46
15
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
47 <param name="minprob" type="text" label="Minimum peptide prophet probability for peptides to be considered" value="0.05"/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
48 <param name="minindep" type="text" label="Minimum percentage of independent peptides required for a protein" value="0"/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
49 </inputs>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
50 <outputs>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
51 <data format="protxml" name="output" from_work_dir="protein_prophet_results.prot.xml"/>
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
52 </outputs>
12
4c66453a168e Uploaded
iracooke
parents:
diff changeset
53
4c66453a168e Uploaded
iracooke
parents:
diff changeset
54
4c66453a168e Uploaded
iracooke
parents:
diff changeset
55 <!--NOPLOT: do not generate plot png file
15
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
56 NOOCCAM: non-conservative maximum protein list
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
57 GROUPWTS: check peptide's total weight in the Protein Group against the threshold (default: check peptide's actual weight against threshold)
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
58 NORMPROTLEN: Normalize NSP using Protein Length
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
59 LOGPROBS: Use the log of the probabilities in the Confidence calculations
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
60 CONFEM: Use the EM to compute probability given the confidence
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
61 ALLPEPS: Consider all possible peptides in the database in the confidence model
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
62 UNMAPPED: Report results for UNMAPPED proteins
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
63 INSTANCES: Use Expected Number of Ion Instances to adjust the peptide probabilities prior to NSP adjustment
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
64 DELUDE: do NOT use peptide degeneracy information when assessing proteins
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
65
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
66 MINPROB: peptideProphet probabilty threshold (default=0.05)
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
67 MININDEP: minimum percentage of independent peptides required for a protein (default=0)
12
4c66453a168e Uploaded
iracooke
parents:
diff changeset
68 -->
4c66453a168e Uploaded
iracooke
parents:
diff changeset
69
15
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
70 <help>
12
4c66453a168e Uploaded
iracooke
parents:
diff changeset
71
4c66453a168e Uploaded
iracooke
parents:
diff changeset
72 **What it does**
4c66453a168e Uploaded
iracooke
parents:
diff changeset
73
4c66453a168e Uploaded
iracooke
parents:
diff changeset
74 Given a set of peptide assignments from MS/MS spectra in the form of a pepXML file, this tool estimates probabilities at the protein level. As output, the tool produces a protXML file, which contains proteins along with the estimated probabilities that those proteins were present. Probabilities are estimated using a statistical model based on the number of peptides corresponding to that protein and the confidence that each of those peptides were assigned correctly. It takes account of the fact that peptides may correspond to more than one protein.
4c66453a168e Uploaded
iracooke
parents:
diff changeset
75
4c66453a168e Uploaded
iracooke
parents:
diff changeset
76 ----
4c66453a168e Uploaded
iracooke
parents:
diff changeset
77
4c66453a168e Uploaded
iracooke
parents:
diff changeset
78 **Citation**
4c66453a168e Uploaded
iracooke
parents:
diff changeset
79
4c66453a168e Uploaded
iracooke
parents:
diff changeset
80 If you use this tool please read and cite the paper describing the statistical model implemented by Protein Prophet
4c66453a168e Uploaded
iracooke
parents:
diff changeset
81
4c66453a168e Uploaded
iracooke
parents:
diff changeset
82 Nesvizhskii A., et al. “A Statistical Model for Identifying Proteins by Tandem Mass Spectrometry” *Anal. Chem.* 75, 4646-4658 (2003).
4c66453a168e Uploaded
iracooke
parents:
diff changeset
83
4c66453a168e Uploaded
iracooke
parents:
diff changeset
84
15
0746a2ae9e04 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 14
diff changeset
85 </help>
12
4c66453a168e Uploaded
iracooke
parents:
diff changeset
86 </tool>