annotate micomplete.xml @ 0:23e768cddc7d draft

Initial commit of micomplete
author lionelguy
date Thu, 17 Oct 2013 08:39:52 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
1 <tool id="micomplete" name="micomplete" version="0.1">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
2 <description>Using hmm profiles of conserved proteins, reports how much complete a (single-cell amplified) genome is</description>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
3 <requirements>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
4 <requirement type="package" version="3.1b1">hmmer</requirement>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
5 </requirements>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
6 <command interpreter="perl">micomplete.pl
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
7 #if $hmm_source.hmm_source_type == "cached"
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
8 --hmm "${ hmm_source.profiles.fields.hmms }"
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
9 --weights "${ hmm_source.profiles.fields.weights }"
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
10 #else
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
11 --hmm "${ hmm_source.own_profiles }"
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
12 #if $hmm_source.weights.use_weights
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
13 --weights "${ hmm_source.weights.own_weights }"
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
14 #end if
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
15 #end if
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
16 --proteome $proteome
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
17 --cut-off $cutoff
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
18 #if $evalue
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
19 --evalue
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
20 #end if
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
21 #if $save_hmm_tab
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
22 --save-hmm-tab $hmm_tab
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
23 #end if
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
24 #if $save_hmm_alignments
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
25 --save-hmm-alignments $hmm_alignments
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
26 #end if
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
27 #if $save_res_tab
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
28 --save-result-tab $res_tab
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
29 #end if
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
30 --threads $threads > $output
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
31 </command>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
32 <inputs>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
33 <param name="proteome" type="data" format="fasta" label="Proteome file" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
34 <conditional name="hmm_source">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
35 <param name="hmm_source_type" type="select" label="HMM file from history or from built-in profile?">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
36 <option value="cached">Use a built-in profile</option>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
37 <option value="history">Use a profile from the history</option>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
38 </param>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
39 <when value="cached">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
40 <param name="profiles" type="select" label="Select a reference set">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
41 <options from_data_table="micomplete_hmms">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
42 <filter type="sort_by" column="2" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
43 </options>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
44 </param>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
45 </when>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
46 <when value="history">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
47 <param name="own_profiles" type="data" format="text" label="Select a HMM set in the history" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
48 <conditional name="weights">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
49 <param name="use_weights" type="boolean" checked="false" truevalue="True" falsevalue="False" label="Use weights?" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
50 <when value="True">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
51 <param name="own_weights" type="data" format="tabular" label="Select a weight file (optional)" help="There should be exactly one weight for each profile in the profiles file"/>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
52 </when>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
53 </conditional>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
54 </when>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
55 </conditional>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
56 <param name="cutoff" type="float" value="1e-10" label="E-value cutoff to include hits" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
57 <param name="evalue" type="boolean" checked="true" truevalue="True" falsevalue="False" label="Show E-values on the output instead of 0/1?" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
58 <param name="save_res_tab" type="boolean" checked="true" truevalue="True" falsevalue="False" label="Save per marker result tabular file?" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
59 <param name="save_hmm_tab" type="boolean" checked="false" truevalue="True" falsevalue="False" label="Save HMM tab result file?" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
60 <param name="save_hmm_alignments" type="boolean" checked="false" truevalue="True" falsevalue="False" label="Save HMM alignments result file?" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
61 <param name="threads" type="integer" value="15" min="1" label="Number of threads to use" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
62 </inputs>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
63 <outputs>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
64 <data format="txt" name="output" label="Completeness report" />
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
65 <data format="tabular" name="res_tab" label="HMM report, tabular format">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
66 <filter>save_res_tab is True</filter>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
67 </data>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
68 <data format="tabular" name="hmm_tab" label="HMM report, tabular format">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
69 <filter>save_hmm_tab is True</filter>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
70 </data>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
71 <data format="txt" name="hmm_alignments" label="HMM alignments">
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
72 <filter>save_hmm_alignments is True</filter>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
73 </data>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
74 </outputs>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
75 <help>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
76 ***What it does***
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
77
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
78 Micomplete estimates the level of completion of a genome. This is particularly useful for single-cell amplified genomes. It aligns a proteome to a set of "markers" or conserved proteins, represented by a collection of HMM profiles, possibly with weights. It uses hmmsearch (http://hmmer.janelia.org/, see for example S.R Eddy, PLOS Comp Biol 2011, 7:e1002195) to align proteins
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
79
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
80 Weights are used to alleviate the effect of having/not having a specific contig which would contain many markers that are generally clustering together. Typically, ribosomal proteins, often used are markers, are often organized in operons. Thus, the impact of having/not having these operons is very important, and should be downplayed to get a more correct estimate.
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
81
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
82 **License**
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
83
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
84 This wrapper is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
85
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
86 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
87
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
88 You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
89 </help>
23e768cddc7d Initial commit of micomplete
lionelguy
parents:
diff changeset
90 </tool>