annotate bandage_info.xml @ 0:067592b6b312 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
author iuc
date Tue, 18 Sep 2018 05:41:44 -0400
parents
children ebe4463404b4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
1 <tool id="bandage_info" name="Bandage Info" version="@TOOL_VERSION@+galaxy0">
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
2 <description>determine statistics of de novo assembly graphs</description>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
3 <macros>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
4 <import>macros.xml</import>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
5 </macros>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
7 <expand macro="version_command"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
8 <command detect_errors="exit_code">
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
9 <![CDATA[
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
10 Bandage
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
11 info
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
12 '$input_file'
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
13 $tsv
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
14 > out.txt
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
15 ]]></command>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
16 <inputs>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
17 <param name="input_file" type="data" format="tabular" label="Graphical Fragment Assembly" />
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
18 <param argument="--tsv" type="boolean" checked="false" truevalue="--tsv" falsevalue="" label="Output the information in a single tab-delimited line starting with the graph file"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
19 </inputs>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
20 <outputs>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
21 <data name="outfile" format="txt" from_work_dir="out.txt" label="${tool.name} on ${on_string}: Assembly Graph Information"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
22 </outputs>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
23 <tests>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
24 <test>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
25 <param name="input_file" ftype="tabular" value="gfa.tabular"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
26 <param name="select_mode" value="info"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
27 <param name="tsv" value="True"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
28 <output name="outfile" ftype="txt" file="out.txt" compare="contains"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
29 </test>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
30 <test>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
31 <param name="input_file" ftype="tabular" value="gfa.tabular"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
32 <param name="select_mode" value="info"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
33 <output name="outfile" ftype="txt" file="out_standard.txt"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
34 </test>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
35 </tests>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
36 <help><![CDATA[
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
37
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
38 @BANDAGE_OVERVIEW@
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
39
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
40 **Command Documentation**
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
41
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
42 ``Bandage info`` takes a graph file as input and outputs the following statistics about the graph:
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
43
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
44 - **Node count:** The number of nodes in the graph. Only positive nodes are counted (i.e. each complementary pair counts as one).
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
45 - **Edge count:** The number of edges in the graph. Only one edge in each complementary pair is counted.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
46 - **Total length:** The total number of base pairs in the graph.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
47 - **Dead ends:** The number of instances where an end of a node does not connect to any other nodes.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
48 - **Percentage dead ends:** The proportion of possible dead ends. The maximum number of dead ends is twice the number of nodes (occurs when there are no edges), so this value is the number of dead ends divided by twice the node count.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
49 - **Connected components:** The number of regions of the graph which are disconnected from each other.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
50 - **Largest component:** The total number of base pairs in the largest connected component.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
51 - **N50:** Nodes that are this length or greater will collectively add up to at least half of the total length.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
52 - **Shortest node:** The length of the shortest node in the graph.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
53 - **Lower quartile node:** The median node length for the shorter half of the nodes.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
54 - **Median node:** The median node length for the graph.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
55 - **Upper quartile node:** The median node length for the longer half of the nodes.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
56 - **Longest node:** The length of the longest node in the graph.
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
57
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
58 Example output::
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
59
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
60 Node count: 561
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
61 Edge count: 734
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
62 Total length (bp): 4878380
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
63 Dead ends: 33
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
64 Percentage dead ends: 2.94118%
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
65 Connected components: 19
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
66 Largest component (bp): 4821329
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
67 N50 (bp): 90360
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
68 Shortest node (bp): 1
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
69 Lower quartile node (bp): 17
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
70 Median node (bp): 87
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
71 Upper quartile node (bp): 404
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
72 Longest node (bp): 205425
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
73
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
74 ]]></help>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
75 <expand macro="citations"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
76 </tool>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
77