annotate cmstat.xml @ 13:ffa96097e5b2 draft

Uploaded
author bgruening
date Fri, 13 Feb 2015 03:12:04 -0500
parents c17ed5a530d2
children 2f8a8962ae22
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
c17ed5a530d2 Uploaded
bgruening
parents: 11
diff changeset
1 <tool id="infernal_cmstat" name="Summary statistics" version="1.1.0.1">
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
2 <description>for covariance model (cmstat)</description>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
3 <requirements>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
4 <requirement type="package">infernal</requirement>
12
c17ed5a530d2 Uploaded
bgruening
parents: 11
diff changeset
5 <requirement type="package" version="1.1">infernal</requirement>
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
6 <requirement type="package" version="8.22">gnu_coreutils</requirement>
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
7 </requirements>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
8 <command>
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
9 <![CDATA[
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
10 ## a temp file is needed, because the standard tabular output from infernal is not usefull in Galaxy
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
11 ## it will be converted to a tab delimited file and piped to Galaxy
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
12 temp_tabular_output=\$(mktemp);
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
13
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
14 cmstat
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
15
11
5c6344f67ad0 Uploaded
bgruening
parents: 9
diff changeset
16 #if str($cm_opts.cm_opts_selector) == "db":
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
17 $cm_opts.database.fields.path
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
18 #else:
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
19 $cm_opts.cmfile
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
20 #end if
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
21
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
22 > \$temp_tabular_output
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
23 ;
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
24
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
25 ## 1. replace all lines starting # (comment lines)
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
26 ## 2. replace the first 18 spaces with tabs, 18th field is a free text field (can contain spaces)
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
27 sed -e 's/#.*$//' -e '/^$/d' -e 's/ /\t/g' -e 's/\t/ /18g' \$temp_tabular_output > $outfile
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
28
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
29 ]]>
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
30 </command>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
31 <inputs>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
32 <conditional name="cm_opts">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
33 <param name="cm_opts_selector" type="select" label="Subject covariance models">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
34 <option value="db" selected="True">Locally installed covariance models</option>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
35 <option value="histdb">Covariance model from your history</option>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
36 </param>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
37 <when value="db">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
38 <param name="database" type="select" label="Covariance models">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
39 <options from_file="infernal.loc">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
40 <column name="value" index="0"/>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
41 <column name="name" index="1"/>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
42 <column name="path" index="2"/>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
43 </options>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
44 </param>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
45 </when>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
46 <when value="histdb">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
47 <param name="cmfile" type="data" format="cm" label="Covariance models file from the history."/>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
48 </when>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
49 </conditional>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
50 </inputs>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
51 <outputs>
11
5c6344f67ad0 Uploaded
bgruening
parents: 9
diff changeset
52 <data format="tabular" name="outfile" label="cmstat on ${on_string}"/>
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
53 </outputs>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
54 <help>
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
55 <![CDATA[
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
56
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
57
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
58 **What it does**
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
59
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
60 The cmstat utility prints out a tabular file of summary statistics for each given covariance model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
61
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
62
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
63 Output format
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
64 -------------
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
65
1aa4c036e41c 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
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
67 tabular format.
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
68
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
69 The columns are:
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
70
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
71 (1) The index of this profile, numbering each on in the file starting from 1.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
72 (2) The name of the profile.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
73 (3) The optional accession of the profile, or ”-” if there is none.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
74 (4) The number of sequences that the profile was estimated from.
1aa4c036e41c 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.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
76 (6) The length of the model in consensus residues (match states).
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
77 (7) The expected maximum length of a hit to the model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
78 (8) The number of basepairs in the model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
79 (9) The number of bifurcations in the model.
1aa4c036e41c 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”.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
81 (11) Mean relative entropy per match state, in bits. This is the expected (mean) score per con-
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
82 sensus position. This is what the default entropy-weighting method for effective sequence
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
83 number estimation focuses on, so for default Infernal, this value will often reflect the default
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
84 target for entropy-weighting. If the ”model” field for this profile is ”hmm”, this field will be ”-”.
1aa4c036e41c 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
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
86 relative entropy, the more the model will rely on structural conservation relative sequence conservation when identifying homologs.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
87
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
88
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
89 For further questions please refere to the Infernal Userguide_.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
90
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
91 .. _Userguide: http://selab.janelia.org/software/infernal/Userguide.pdf
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
92
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
93
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
94 How do I cite Infernal?
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
95 -----------------------
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
96
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
97 The recommended citation for using Infernal 1.1 is E. P. Nawrocki and S. R. Eddy, Infernal 1.1: 100-fold faster RNA homology searches , Bioinformatics 29:2933-2935 (2013).
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
98
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
99 **Galaxy Wrapper Author**::
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
100
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
101 * Bjoern Gruening, University of Freiburg
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
102
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
103 ]]>
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
104 </help>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
105 </tool>