annotate cmstat.xml @ 4:c47a7c52ac4f draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 236abfe2af8034017994daea08079887e64b68c8
author bgruening
date Mon, 19 Dec 2016 15:27:06 -0500
parents 2c2c5e5e495b
children 6e18e0b098cd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
652f9d550531 Uploaded
bgruening
parents:
diff changeset
1 <tool id="infernal_cmstat" name="Summary statistics" version="1.1.0.1">
652f9d550531 Uploaded
bgruening
parents:
diff changeset
2 <description>for covariance model (cmstat)</description>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
3 <requirements>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
4 <requirement type="package">infernal</requirement>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
5 <requirement type="package" version="1.1">infernal</requirement>
2
fac157e22e1b Uploaded
bgruening
parents: 0
diff changeset
6 <requirement type="package" version="8.22">gnu_coreutils</requirement>
0
652f9d550531 Uploaded
bgruening
parents:
diff changeset
7 </requirements>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
8 <command>
2
fac157e22e1b Uploaded
bgruening
parents: 0
diff changeset
9 <![CDATA[
0
652f9d550531 Uploaded
bgruening
parents:
diff changeset
10 ## a temp file is needed, because the standard tabular output from infernal is not usefull in Galaxy
652f9d550531 Uploaded
bgruening
parents:
diff changeset
11 ## it will be converted to a tab delimited file and piped to Galaxy
652f9d550531 Uploaded
bgruening
parents:
diff changeset
12 temp_tabular_output=\$(mktemp);
652f9d550531 Uploaded
bgruening
parents:
diff changeset
13
652f9d550531 Uploaded
bgruening
parents:
diff changeset
14 cmstat
652f9d550531 Uploaded
bgruening
parents:
diff changeset
15
652f9d550531 Uploaded
bgruening
parents:
diff changeset
16 #if str($cm_opts.cm_opts_selector) == "db":
652f9d550531 Uploaded
bgruening
parents:
diff changeset
17 $cm_opts.database.fields.path
652f9d550531 Uploaded
bgruening
parents:
diff changeset
18 #else:
652f9d550531 Uploaded
bgruening
parents:
diff changeset
19 $cm_opts.cmfile
652f9d550531 Uploaded
bgruening
parents:
diff changeset
20 #end if
652f9d550531 Uploaded
bgruening
parents:
diff changeset
21
652f9d550531 Uploaded
bgruening
parents:
diff changeset
22 > \$temp_tabular_output
652f9d550531 Uploaded
bgruening
parents:
diff changeset
23 ;
652f9d550531 Uploaded
bgruening
parents:
diff changeset
24
652f9d550531 Uploaded
bgruening
parents:
diff changeset
25 ## 1. replace all lines starting # (comment lines)
652f9d550531 Uploaded
bgruening
parents:
diff changeset
26 ## 2. replace the first 18 spaces with tabs, 18th field is a free text field (can contain spaces)
652f9d550531 Uploaded
bgruening
parents:
diff changeset
27 sed -e 's/#.*$//' -e '/^$/d' -e 's/ /\t/g' -e 's/\t/ /18g' \$temp_tabular_output > $outfile
652f9d550531 Uploaded
bgruening
parents:
diff changeset
28
2
fac157e22e1b Uploaded
bgruening
parents: 0
diff changeset
29 ]]>
0
652f9d550531 Uploaded
bgruening
parents:
diff changeset
30 </command>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
31 <inputs>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
32 <conditional name="cm_opts">
652f9d550531 Uploaded
bgruening
parents:
diff changeset
33 <param name="cm_opts_selector" type="select" label="Subject covariance models">
652f9d550531 Uploaded
bgruening
parents:
diff changeset
34 <option value="db" selected="True">Locally installed covariance models</option>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
35 <option value="histdb">Covariance model from your history</option>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
36 </param>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
37 <when value="db">
652f9d550531 Uploaded
bgruening
parents:
diff changeset
38 <param name="database" type="select" label="Covariance models">
652f9d550531 Uploaded
bgruening
parents:
diff changeset
39 <options from_file="infernal.loc">
652f9d550531 Uploaded
bgruening
parents:
diff changeset
40 <column name="value" index="0"/>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
41 <column name="name" index="1"/>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
42 <column name="path" index="2"/>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
43 </options>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
44 </param>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
45 </when>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
46 <when value="histdb">
652f9d550531 Uploaded
bgruening
parents:
diff changeset
47 <param name="cmfile" type="data" format="cm" label="Covariance models file from the history."/>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
48 </when>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
49 </conditional>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
50 </inputs>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
51 <outputs>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
52 <data format="tabular" name="outfile" label="cmstat on ${on_string}"/>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
53 </outputs>
652f9d550531 Uploaded
bgruening
parents:
diff changeset
54 <help>
2
fac157e22e1b Uploaded
bgruening
parents: 0
diff changeset
55 <![CDATA[
0
652f9d550531 Uploaded
bgruening
parents:
diff changeset
56
652f9d550531 Uploaded
bgruening
parents:
diff changeset
57
652f9d550531 Uploaded
bgruening
parents:
diff changeset
58 **What it does**
652f9d550531 Uploaded
bgruening
parents:
diff changeset
59
652f9d550531 Uploaded
bgruening
parents:
diff changeset
60 The cmstat utility prints out a tabular file of summary statistics for each given covariance model.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
61
652f9d550531 Uploaded
bgruening
parents:
diff changeset
62
3
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
63 **Output format**
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
64
0
652f9d550531 Uploaded
bgruening
parents:
diff changeset
65
652f9d550531 Uploaded
bgruening
parents:
diff changeset
66 By default, cmstat prints general statistics of the model and the alignment it was built from, one line per model in a
2
fac157e22e1b Uploaded
bgruening
parents: 0
diff changeset
67 tabular format.
0
652f9d550531 Uploaded
bgruening
parents:
diff changeset
68
652f9d550531 Uploaded
bgruening
parents:
diff changeset
69 The columns are:
652f9d550531 Uploaded
bgruening
parents:
diff changeset
70
652f9d550531 Uploaded
bgruening
parents:
diff changeset
71 (1) The index of this profile, numbering each on in the file starting from 1.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
72 (2) The name of the profile.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
73 (3) The optional accession of the profile, or ”-” if there is none.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
74 (4) The number of sequences that the profile was estimated from.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
75 (5) The effective number of sequences that the profile was estimated from, after Infernal applied an effective sequence number calculation such as the default entropy weighting.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
76 (6) The length of the model in consensus residues (match states).
652f9d550531 Uploaded
bgruening
parents:
diff changeset
77 (7) The expected maximum length of a hit to the model.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
78 (8) The number of basepairs in the model.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
79 (9) The number of bifurcations in the model.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
80 (10) What type of model will be used by default in cmsearch and cmscan for this profile, either ”cm” or ”hmm”. For profiles with 0 basepairs, this will be ”hmm” (unless the --nohmmonly option is used). For all other profiles, this will be ”cm”.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
81 (11) Mean relative entropy per match state, in bits. This is the expected (mean) score per con-
652f9d550531 Uploaded
bgruening
parents:
diff changeset
82 sensus position. This is what the default entropy-weighting method for effective sequence
652f9d550531 Uploaded
bgruening
parents:
diff changeset
83 number estimation focuses on, so for default Infernal, this value will often reflect the default
652f9d550531 Uploaded
bgruening
parents:
diff changeset
84 target for entropy-weighting. If the ”model” field for this profile is ”hmm”, this field will be ”-”.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
85 (12) Mean relative entropy per match state, in bits, if the CM were transformed into an HMM (information from structure is ignored). The larger the difference between the CM and HMM
652f9d550531 Uploaded
bgruening
parents:
diff changeset
86 relative entropy, the more the model will rely on structural conservation relative sequence conservation when identifying homologs.
652f9d550531 Uploaded
bgruening
parents:
diff changeset
87
652f9d550531 Uploaded
bgruening
parents:
diff changeset
88
3
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
89 For further questions please refere to the Infernal `Userguide <http://selab.janelia.org/software/infernal/Userguide.pdf>`_.
0
652f9d550531 Uploaded
bgruening
parents:
diff changeset
90
2
fac157e22e1b Uploaded
bgruening
parents: 0
diff changeset
91 ]]>
0
652f9d550531 Uploaded
bgruening
parents:
diff changeset
92 </help>
3
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
93 <citations>
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
94 <citation type="doi">10.1093/bioinformatics/btt509</citation>
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
95 <citation type="bibtex">
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
96 @ARTICLE{bgruening_galaxytools,
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
97 Author = {Björn Grüning, Cameron Smith, Torsten Houwaart, Nicola Soranzo, Eric Rasche},
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
98 keywords = {bioinformatics, ngs, galaxy, cheminformatics, rna},
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
99 title = {{Galaxy Tools - A collection of bioinformatics and cheminformatics tools for the Galaxy environment}},
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
100 url = {https://github.com/bgruening/galaxytools}
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
101 }
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
102 </citation>
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
103 </citations>
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
104
2c2c5e5e495b planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 2
diff changeset
105
0
652f9d550531 Uploaded
bgruening
parents:
diff changeset
106 </tool>