annotate macros.xml @ 3:e12898633ceb draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit 3234c3d93fa294fa9c2c5148eae4b399d42904d8
author iuc
date Fri, 23 Aug 2024 08:18:06 +0000
parents 9a0944d08a99
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
1 <macros>
3
e12898633ceb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit 3234c3d93fa294fa9c2c5148eae4b399d42904d8
iuc
parents: 2
diff changeset
2 <token name="@TOOL_VERSION@">1.5.0</token>
1
9471e3d97837 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit e0934fc66bfd742731505cacd18cbf53b26d4f2a
iuc
parents: 0
diff changeset
3 <!-- token name="@VERSION_SUFFIX@">0</token -->
0
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
4 <token name="@PROFILE@">20.09</token>
2
9a0944d08a99 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit a5e28ac40a63a269100ddec5629aee5256ce00ef
iuc
parents: 1
diff changeset
5 <xml name="bio_tools">
9a0944d08a99 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit a5e28ac40a63a269100ddec5629aee5256ce00ef
iuc
parents: 1
diff changeset
6 <xrefs>
9a0944d08a99 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit a5e28ac40a63a269100ddec5629aee5256ce00ef
iuc
parents: 1
diff changeset
7 <xref type="bio.tools">dram</xref>
9a0944d08a99 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit a5e28ac40a63a269100ddec5629aee5256ce00ef
iuc
parents: 1
diff changeset
8 </xrefs>
9a0944d08a99 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit a5e28ac40a63a269100ddec5629aee5256ce00ef
iuc
parents: 1
diff changeset
9 </xml>
0
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
10 <xml name="requirements">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
11 <requirements>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
12 <requirement type="package" version="@TOOL_VERSION@">dram</requirement>
3
e12898633ceb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit 3234c3d93fa294fa9c2c5148eae4b399d42904d8
iuc
parents: 2
diff changeset
13 <yield/>
0
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
14 </requirements>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
15 </xml>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
16 <xml name="stdio">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
17 <stdio>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
18 <regex match="FileNotFoundError" source="stderr" level="fatal"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
19 <regex match="returned non-zero exit status" source="stdout" level="fatal"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
20 <regex match="returned non-zero exit status" source="stderr" level="fatal"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
21 <regex match="Invalid file path or buffer object type" source="stderr" level="fatal"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
22 <exit_code range="1:" level="fatal"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
23 </stdio>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
24 </xml>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
25 <xml name="categories_param">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
26 <param argument="--categories" type="text" value="" label="Distillate categories" help="Optional, leave blank to ignore">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
27 <expand macro="sanitizer"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
28 </param>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
29 </xml>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
30 <xml name="custom_distillate_param">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
31 <param argument="--custom_distillate" type="data" format="tabular" optional="true" label="File containing a custom distillate form" help="Optional, leave blank to ignore"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
32 </xml>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
33 <xml name="genes_param">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
34 <param argument="--genes" type="text" value="" label="Space-separated list of genes to keep" help="Optional, leave blank to ignore">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
35 <expand macro="sanitizer"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
36 </param>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
37 </xml>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
38 <xml name="identifiers_param">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
39 <param argument="--identifiers" type="text" value="" label="Database identifiers" help="Optional, leave blank to ignore">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
40 <expand macro="sanitizer"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
41 </param>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
42 </xml>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
43 <xml name="input_file_param">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
44 <param argument="--input_file" type="data" format="tabular" label="Annotations file" help="Produced by the DRAM annotate tool"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
45 </xml>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
46 <xml name="sanitizer">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
47 <sanitizer>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
48 <valid initial="string.printable">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
49 <remove value="&apos;"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
50 </valid>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
51 <mapping initial="none">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
52 <add source="&apos;" target="__sq__"/>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
53 </mapping>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
54 </sanitizer>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
55 </xml>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
56 <token name="@WHATITDOESHEADER@">DRAM (Distilled and Refined Annotation of Metabolism) is a tool for annotating metagenomic assembled genomes and VirSorter identified viral contigs. DRAM annotates MAGs and viral contigs using UniRef90, PFAM, dbCAN, RefSeq viral, VOGDB and the MEROPS peptidase database.</token>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
57 <token name="@CUSTOMDISTILLATEFILES@">**Using Custom Distillate files**
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
58
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
59 The custom distillate sheet must be a tabular file with all the columns specified below. This sheet is an extension
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
60 of the genome_summary_form.tsv file that is installed with the dram databases and which is one of several key data files
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
61 that characterizes the distillate. The genome_summary_form.tsv file is available for viewing here
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
62 https://github.com/WrightonLabCSU/DRAM/blob/master/data/genome_summary_form.tsv. The custom distillate sheet must
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
63 contain the following columns.
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
64
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
65 * gene_id: the KO ids of the genes in which you are interested
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
66 * gene_description: descriptions of the geans
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
67 * module: the name of your module that you are adding
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
68 * sheet: the name you would like on the excel sheet in which your results appear
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
69 * header: the header that will appear in the dram metabolism summary
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
70 * subheader: the sub-header that will appear in the metabolism summary</token>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
71 <token name="@WHATITDOESFOOTER@">More information about DRAM can be found here https://github.com/shafferm/DRAM/wiki.</token>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
72 <xml name="citations">
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
73 <citations>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
74 <citation type="doi">10.1186/s13104-016-1900-2</citation>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
75 </citations>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
76 </xml>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
77 </macros>
f9a3ea1c618c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
iuc
parents:
diff changeset
78