annotate bandage_info.xml @ 5:d8b1027d6ce0 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit 7823462e83ff5efbcfd3161f7d471fd07da51611"
author iuc
date Sun, 12 Sep 2021 08:13:13 +0000
parents b2860df42e16
children b9e31c5c01c7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
d8b1027d6ce0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit 7823462e83ff5efbcfd3161f7d471fd07da51611"
iuc
parents: 3
diff changeset
1 <tool id="bandage_info" name="Bandage Info" version="@TOOL_VERSION@+galaxy2" profile="18.01">
0
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>
5
d8b1027d6ce0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit 7823462e83ff5efbcfd3161f7d471fd07da51611"
iuc
parents: 3
diff changeset
3 <expand macro="bio_tools"/>
0
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
4 <macros>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
5 <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
6 </macros>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
7 <expand macro="requirements"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
8 <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
9 <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
10 <![CDATA[
3
b2860df42e16 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit ef940ee99e8bf07cfe86b273a3eda72f09003fb3"
iuc
parents: 1
diff changeset
11 @HEADLESS@
0
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
12 Bandage
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
13 info
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
14 '$input_file'
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
15 $tsv
5
d8b1027d6ce0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit 7823462e83ff5efbcfd3161f7d471fd07da51611"
iuc
parents: 3
diff changeset
16 | sed 's/:\s\+/:\t/g'
d8b1027d6ce0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit 7823462e83ff5efbcfd3161f7d471fd07da51611"
iuc
parents: 3
diff changeset
17 > out.tab
0
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
18 ]]></command>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
19 <inputs>
1
ebe4463404b4 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit 5badd53c6fdaf43796ffacff94852356696d30d0
iuc
parents: 0
diff changeset
20 <param name="input_file" type="data" format="txt" label="Graphical Fragment Assembly" help="Supports multiple assembly graph formats: LastGraph (Velvet), FASTG (SPAdes), Trinity.fasta, ASQG and GFA."/>
0
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
21 <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
22 </inputs>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
23 <outputs>
5
d8b1027d6ce0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit 7823462e83ff5efbcfd3161f7d471fd07da51611"
iuc
parents: 3
diff changeset
24 <data name="outfile" format="tabular" from_work_dir="out.tab" label="${tool.name} on ${on_string}: Assembly Graph Information"/>
0
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
25 </outputs>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
26 <tests>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
27 <test>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
28 <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
29 <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
30 <param name="tsv" value="True"/>
5
d8b1027d6ce0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit 7823462e83ff5efbcfd3161f7d471fd07da51611"
iuc
parents: 3
diff changeset
31 <output name="outfile" ftype="tabular" file="out.tab" compare="contains"/>
0
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
32 </test>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
33 <test>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
34 <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
35 <param name="select_mode" value="info"/>
5
d8b1027d6ce0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit 7823462e83ff5efbcfd3161f7d471fd07da51611"
iuc
parents: 3
diff changeset
36 <output name="outfile" ftype="tabular" file="out_standard.tab"/>
0
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
37 </test>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
38 </tests>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
39 <help><![CDATA[
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
40
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
41 @BANDAGE_OVERVIEW@
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
42
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
43 **Command Documentation**
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
44
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
45 ``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
46
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
47 - **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
48 - **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
49 - **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
50 - **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
51 - **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
52 - **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
53 - **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
54 - **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
55 - **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
56 - **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
57 - **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
58 - **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
59 - **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
60
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
61 Example output::
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
62
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
63 Node count: 561
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
64 Edge count: 734
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
65 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
66 Dead ends: 33
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
67 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
68 Connected components: 19
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
69 Largest component (bp): 4821329
5
d8b1027d6ce0 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit 7823462e83ff5efbcfd3161f7d471fd07da51611"
iuc
parents: 3
diff changeset
70 N50 (bp): 90360
0
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
71 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
72 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
73 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
74 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
75 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
76
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
77 ]]></help>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
78 <expand macro="citations"/>
067592b6b312 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bandage commit d5e71a9c6eeb449a00c335a244e5348c9bd49c16
iuc
parents:
diff changeset
79 </tool>