annotate cmstat.xml @ 9:1aa4c036e41c draft

Uploaded
author bgruening
date Sat, 07 Sep 2013 16:14:02 -0400
parents
children 5c6344f67ad0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
1 <tool id="infernal_cmstat" name="Summary statistics" version="1.1.0.0">
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>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
5 <requirement type="package" version="1.1rc4">infernal</requirement>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
6 <requirement type="package" version="8.21">gnu_coreutils</requirement>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
7 </requirements>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
8 <command>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
9 ## a temp file is needed, because the standard tabular output from infernal is not usefull in Galaxy
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
10 ## it will be converted to a tab delimited file and piped to Galaxy
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
11 temp_tabular_output=\$(mktemp);
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
12
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
13 cmstat
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
14
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
15 #if $cm_opts.cm_opts_selector == "db":
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
16 $cm_opts.database.fields.path
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
17 #else:
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
18 $cm_opts.cmfile
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
19 #end if
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
20
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
21 > \$temp_tabular_output
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
22 ;
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
23
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
24 ## 1. replace all lines starting # (comment lines)
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
25 ## 2. replace the first 18 spaces with tabs, 18th field is a free text field (can contain spaces)
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
26 sed -e 's/#.*$//' -e '/^$/d' -e 's/ /\t/g' -e 's/\t/ /18g' \$temp_tabular_output > $outfile
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
27
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
28 </command>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
29 <inputs>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
30 <conditional name="cm_opts">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
31 <param name="cm_opts_selector" type="select" label="Subject covariance models">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
32 <option value="db" selected="True">Locally installed covariance models</option>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
33 <option value="histdb">Covariance model from your history</option>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
34 </param>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
35 <when value="db">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
36 <param name="database" type="select" label="Covariance models">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
37 <options from_file="infernal.loc">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
38 <column name="value" index="0"/>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
39 <column name="name" index="1"/>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
40 <column name="path" index="2"/>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
41 </options>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
42 </param>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
43 </when>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
44 <when value="histdb">
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
45 <param name="cmfile" type="data" format="cm" label="Covariance models file from the history."/>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
46 </when>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
47 </conditional>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
48 </inputs>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
49 <outputs>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
50 <data format="tabular" name="outfile" label="cmsearch on ${on_string}"/>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
51 </outputs>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
52 <help>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
53
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
54
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
55 **What it does**
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
56
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
57 The cmstat utility prints out a tabular file of summary statistics for each given covariance model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
58
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
59
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
60 Output format
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
61 -------------
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
62
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
63 By default, cmstat prints general statistics of the model and the alignment it was built from, one line per model in a
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
64 tabular format.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
65
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
66 The columns are:
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
67
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
68 (1) The index of this profile, numbering each on in the file starting from 1.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
69 (2) The name of the profile.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
70 (3) The optional accession of the profile, or ”-” if there is none.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
71 (4) The number of sequences that the profile was estimated from.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
72 (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
73 (6) The length of the model in consensus residues (match states).
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
74 (7) The expected maximum length of a hit to the model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
75 (8) The number of basepairs in the model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
76 (9) The number of bifurcations in the model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
77 (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
78 (11) Mean relative entropy per match state, in bits. This is the expected (mean) score per con-
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
79 sensus position. This is what the default entropy-weighting method for effective sequence
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
80 number estimation focuses on, so for default Infernal, this value will often reflect the default
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
81 target for entropy-weighting. If the ”model” field for this profile is ”hmm”, this field will be ”-”.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
82 (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
83 relative entropy, the more the model will rely on structural conservation relative sequence conservation when identifying homologs.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
84
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
85
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
86 For further questions please refere to the Infernal Userguide_.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
87
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
88 .. _Userguide: http://selab.janelia.org/software/infernal/Userguide.pdf
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
89
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
90
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
91 How do I cite Infernal?
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
92 -----------------------
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
93
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
94 The Infernal 1.0 paper (Nawrocki et al., 2009) is the best paper to reference.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
95 If you’re writing for an enlightened (url-friendly) journal, you may want to cite the webpage
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
96 http://infernal.janelia.org/ because it is kept up-to-date. We hope to publish a paper related to
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
97 Infernal version 1.1 soon.
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
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
103 </help>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
104 </tool>