annotate cmstat.xml @ 20:b10f7688d14c draft

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
author bgruening
date Mon, 11 Nov 2024 10:26:56 +0000
parents 94cc7ef25867
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
94cc7ef25867 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit a812ed8de433ac4e8b42afd636e70cfbb180d2b9"
bgruening
parents: 16
diff changeset
1 <tool id="infernal_cmstat" name="cmstat" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@">
16
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
2 <description>Summary statistics for covariance model </description>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
3 <macros>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
4 <import>macros.xml</import>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
5 </macros>
20
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
6 <expand macro="xrefs"/>
16
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
7 <expand macro="requirements"/>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
8 <expand macro="stdio" />
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
9 <command>
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
10 <![CDATA[
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
11 ## a temp file is needed, because the standard tabular output from infernal is not usefull in Galaxy
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
12 ## it will be converted to a tab delimited file and piped to Galaxy
16
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
13 ##temp_tabular_output=\$(mktemp);
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
14
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
15 cmstat
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
16
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
22 > $outfile
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
23
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
24
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
25 ]]>
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
26 </command>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
27 <inputs>
20
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
28 <expand macro="DB" />
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
29 </inputs>
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
30 <outputs>
11
5c6344f67ad0 Uploaded
bgruening
parents: 9
diff changeset
31 <data format="tabular" name="outfile" label="cmstat on ${on_string}"/>
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
32 </outputs>
16
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
33 <tests>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
34 <test>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
35 <conditional name="cm_opts">
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
36 <param name="cm_opts_selector" value="histdb"/>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
37 <param name="cmfile" value="cmstat_input.cm"/>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
38 </conditional>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
39 <output name="outfile" >
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
40 <assert_contents>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
41 <has_text text="idx"/>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
42 <has_text text="accession"/>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
43 <has_text text="nseq"/>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
44 </assert_contents>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
45 </output>
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
46 </test>
20
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
47 <test>
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
48 <conditional name="cm_opts">
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
49 <param name="cm_opts_selector" value="db"/>
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
50 <param name="database" value="cmstat_input.cm"/>
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
51 </conditional>
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
52 <output name="outfile" >
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
53 <assert_contents>
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
54 <has_text text="idx"/>
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
55 <has_text text="accession"/>
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
56 <has_text text="nseq"/>
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
57 </assert_contents>
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
58 </output>
b10f7688d14c planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 09c1d4ab75f5cd057ed57bf694217f0e355f785e
bgruening
parents: 19
diff changeset
59 </test>
16
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
60 </tests>
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
61 <help>
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
62 <![CDATA[
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
63
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
64
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
65 **What it does**
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
66
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
67 The cmstat utility prints out a tabular file of summary statistics for each given covariance model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
68
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
69
14
2f8a8962ae22 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 13
diff changeset
70 **Output format**
2f8a8962ae22 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 9eeedfaf35c069d75014c5fb2e42046106bf813c-dirty
bgruening
parents: 13
diff changeset
71
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
72
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
73 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
74 tabular format.
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
75
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
76 The columns are:
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
77
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
78 (1) The index of this profile, numbering each on in the file starting from 1.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
79 (2) The name of the profile.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
80 (3) The optional accession of the profile, or ”-” if there is none.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
81 (4) The number of sequences that the profile was estimated from.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
82 (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
83 (6) The length of the model in consensus residues (match states).
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
84 (7) The expected maximum length of a hit to the model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
85 (8) The number of basepairs in the model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
86 (9) The number of bifurcations in the model.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
87 (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
88 (11) Mean relative entropy per match state, in bits. This is the expected (mean) score per con-
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
89 sensus position. This is what the default entropy-weighting method for effective sequence
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
90 number estimation focuses on, so for default Infernal, this value will often reflect the default
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
91 target for entropy-weighting. If the ”model” field for this profile is ”hmm”, this field will be ”-”.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
92 (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
93 relative entropy, the more the model will rely on structural conservation relative sequence conservation when identifying homologs.
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
94
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
95
16
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
96 For further questions please refere to the Infernal `Userguide <http://eddylab.org/infernal/Userguide.pdf>`_.
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
97
13
ffa96097e5b2 Uploaded
bgruening
parents: 12
diff changeset
98 ]]>
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
99 </help>
16
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
100 <expand macro="citations" />
0ac29b4bb1cb planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/infernal commit 80c721dcfe02a2b8baf8e2c64b76cbcd71b23d86
bgruening
parents: 14
diff changeset
101
9
1aa4c036e41c Uploaded
bgruening
parents:
diff changeset
102 </tool>