annotate protein_prophet.xml @ 18:84b47300a4c8 draft default tip

planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
author iracooke
date Tue, 20 Oct 2015 20:46:16 -0400
parents b68f292b2904
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
1 <tool id="proteomics_search_protein_prophet_1" name="Protein Prophet" version="1.1.1">
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
2 <description>Calculate Protein Prophet statistics on search results</description>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
3 <requirements>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
4 <container type="docker">iracooke/protk-1.4.3</container>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
5 <requirement type="package" version="1.4.3">protk</requirement>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
6 <requirement type="package" version="4.8.0">trans_proteomic_pipeline</requirement>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
7 </requirements>
17
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
8
18
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
9 <command>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
10 protein_prophet.rb
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
11 --galaxy
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
12
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
13 #for $input_file in $input_files:
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
14 ${input_file}
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
15 #end for
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
16
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
17 -o protein_prophet_results.prot.xml
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
18 -r
17
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
19
18
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
20 $iproph
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
21 $nooccam
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
22 $groupwts
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
23 $normprotlen
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
24 $logprobs
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
25 $confem
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
26 $allpeps
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
27 $unmapped
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
28 $instances
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
29 $delude
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
30 --minprob=$minprob
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
31 --minindep=$minindep
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
32 </command>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
33 <inputs>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
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"/>
17
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
35
18
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
36 <param name="iproph" selected="true" type="boolean" label="Inputs are from iProphet" truevalue="--iprophet-input" falsevalue=""/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
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=""/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
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=""/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
39 <param name="normprotlen" type="boolean" label="Normalize NSP using Protein Length" truevalue="--norm-protlen" falsevalue=""/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
40 <param name="logprobs" type="boolean" label="Use the log of probability in the confidence calculations" truevalue="--log-prob" falsevalue=""/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
41 <param name="confem" type="boolean" label="Use the EM to compute probability given the confidenct" truevalue="--confem" falsevalue=""/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
42 <param name="allpeps" type="boolean" label="Consider all possible peptides in the database in the confidence model" truevalue="--allpeps" falsevalue=""/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
43 <param name="unmapped" type="boolean" label="Report results for unmapped proteins" truevalue="--unmapped" falsevalue=""/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
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=""/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
45 <param name="delude" type="boolean" label="Do NOT use peptide degeneracy information when assessing proteins" truevalue="--delude" falsevalue=""/>
17
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
46
18
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
47 <param name="minprob" type="text" label="Minimum peptide prophet probability for peptides to be considered" value="0.05"/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
48 <param name="minindep" type="text" label="Minimum percentage of independent peptides required for a protein" value="0"/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
49 </inputs>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
50 <outputs>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
51 <data format="protxml" name="output" from_work_dir="protein_prophet_results.prot.xml"/>
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
52 </outputs>
17
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
53
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
54
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
55 <!--NOPLOT: do not generate plot png file
18
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
56 NOOCCAM: non-conservative maximum protein list
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
57 GROUPWTS: check peptide's total weight in the Protein Group against the threshold (default: check peptide's actual weight against threshold)
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
58 NORMPROTLEN: Normalize NSP using Protein Length
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
59 LOGPROBS: Use the log of the probabilities in the Confidence calculations
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
60 CONFEM: Use the EM to compute probability given the confidence
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
61 ALLPEPS: Consider all possible peptides in the database in the confidence model
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
62 UNMAPPED: Report results for UNMAPPED proteins
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
63 INSTANCES: Use Expected Number of Ion Instances to adjust the peptide probabilities prior to NSP adjustment
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
64 DELUDE: do NOT use peptide degeneracy information when assessing proteins
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
65
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
66 MINPROB: peptideProphet probabilty threshold (default=0.05)
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
67 MININDEP: minimum percentage of independent peptides required for a protein (default=0)
17
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
68 -->
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
69
18
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
70 <help>
17
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
71
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
72 **What it does**
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
73
b68f292b2904 Uploaded
simonalpha
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.
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
75
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
76 ----
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
77
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
78 **Citation**
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
79
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
80 If you use this tool please read and cite the paper describing the statistical model implemented by Protein Prophet
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
81
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
82 Nesvizhskii A., et al. “A Statistical Model for Identifying Proteins by Tandem Mass Spectrometry” *Anal. Chem.* 75, 4646-4658 (2003).
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
83
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
84
18
84b47300a4c8 planemo upload for repository https://github.com/iracooke/protk-galaxytools/blob/master/tpp-prophets/.shed.yml commit 24e0fef2496984648a8a5cd5bff4d6b9b634a302-dirty
iracooke
parents: 17
diff changeset
85 </help>
17
b68f292b2904 Uploaded
simonalpha
parents:
diff changeset
86 </tool>