Mercurial > repos > iuc > dram_distill

comparison dram_distill.xml @ 0:f9a3ea1c618c draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dram commit df10ba86507266a6a6f83c9bbefb7191a41b46f5
author iuc
date Sat, 10 Dec 2022 21:15:05 +0000
parents
children 9471e3d97837
comparison
equal deleted inserted replaced
-1:000000000000 0:f9a3ea1c618c
1 <tool id="dram_distill" name="DRAM distill" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
2 <description>metagenome-assembled-genomes (MAGs)</description>
3 <macros>
4 <import>macros.xml</import>
5 </macros>
6 <expand macro="requirements"/>
7 <expand macro="stdio"/>
8 <command detect_errors="exit_code"><![CDATA[
9 DRAM.py distill
10 --input_file '$input_file'
11 --output_dir 'output_dir'
12 #if $rrna_path:
13 --rrna_path '$rrna_path'
14 #end if
15 #if $trna_path:
16 --trna_path '$trna_path'
17 #end if
18 --groupby_column '$groupby_column'
19 #if $custom_distillate:
20 --custom_distillate '$custom_distillate'
21 #end if
22 $distillate_gene_names
23 --genomes_per_product $genomes_per_product
24 && test -f 'output_dir/genome_stats.tsv' && mv 'output_dir/genome_stats.tsv' '$output_genome_stats' || echo 'No genome_stats.tsv output produced'
25 && test -f 'output_dir/metabolism_summary.xlsx' && mv 'output_dir/metabolism_summary.xlsx' '$output_metabolism_summary' || echo 'No metabolism_summary.xlsx output produced'
26 && test -f 'output_dir/product.html' && mv 'output_dir/product.html' '$output_product_html' || echo 'No product.html output produced'
27 && test -f 'output_dir/product.tsv' && mv 'output_dir/product.tsv' '$output_product_tsv' || echo 'No product.tsv output produced'
28 ]]></command>
29 <inputs>
30 <expand macro="input_file_param"/>
31 <param argument="--rrna_path" type="data" format="tabular" optional="true" label="rRNA file" help="Produced by the DRAM annotate tool (optional, leave blank to ignore)"/>
32 <param argument="--trna_path" type="data" format="tabular" optional="true" label="tRNA file" help="Produced by the DRAM annotate tool (optional, leave blank to ignore)"/>
33 <param argument="--groupby_column" type="text" value="fasta" label="Column from annotations to group as organism units">
34 <expand macro="sanitizer"/>
35 </param>
36 <expand macro="custom_distillate_param"/>
37 <param argument="--distillate_gene_names" type="boolean" truevalue="--distillate_gene_names" falsevalue="" checked="false" label="Give names of genes instead of counts in genome metabolism summary?"/>
38 <param argument="--genomes_per_product" type="integer" value="1000" min="0" label="Number of genomes per product.html output"/>
39 </inputs>
40 <outputs>
41 <data name="output_genome_stats" format="tabular" label="${tool.name} on ${on_string}: genome stats"/>
42 <data name="output_metabolism_summary" format="xlsx" label="${tool.name} on ${on_string}: metabolism summary"/>
43 <data name="output_product_html" format="html" label="${tool.name} on ${on_string}: product html"/>
44 <data name="output_product_tsv" format="tabular" label="${tool.name} on ${on_string}: product_tsv"/>
45 </outputs>
46 <tests>
47 <!--
48 These tests succeed, but the outputs are empty because the DRAM
49 database is not available in the test environment. This warning
50 is displayed in the log...
51 warnings.warn('Database does not exist at path %s' % self.description_loc)
52 ...and this exception is raised:
53 ValueError: Invalid file path or buffer object type: <class 'NoneType'
54 -->
55 <test expect_failure="true">
56 <param name="input_file" ftype="tabular" value="annotated1.tabular"/>
57 <param name="rrna_path" ftype="tabular" value="input_distill_rrna1.tabular"/>
58 <param name="trna_path" ftype="tabular" value="input_distill_trna1.tabular"/>
59 <param name="custom_distillate" ftype="tabular" value="distill_custom.tabular"/>
60 <assert_stderr>
61 <has_text text="Traceback"/>
62 </assert_stderr>
63 </test>
64 </tests>
65 <help>
66 **What it does**
67
68 @WHATITDOESHEADER@
69
70 This tool accepts a tabular file with all gene annotations from Pfam, UniProt, dbCAN and MEROPS databases produced by the
71 DRAM annotate tool and curates them into useful functional categories, creating genome statistics and metabolism summary
72 files. The genome statistics provides most genome quality information required for MIMAG standards, including GTDB-tk
73 and checkM information if provided by the user. The summarised metabolism table includes the number of genes with specific
74 metabolic function identifiers (KO, CAZY ID, etc) for each genome with information obtained from multiple databases.
75
76 @CUSTOMDISTILLATEFILES@
77
78 This tool produces the following outputs.
79
80 * **Distillate**
81
82 * **genome stats** - a tabular file with genome statistics for all input genomes including all statistics required by recently defined MIMAG standards
83 * **metabolism summary** - an Excel file with metabolism summary of all input genomes which gives gene counts of functional and structural genes across a wide variety of metabolisms
84
85 * **Liquor**
86
87 * **product html** - an html file containing an interactive heatmap showing coverage of pathways, the coverage of electron transport chain components and the presence of selected metabolic functions
88 * **product tsv** - a tabular file with corresponding genes for the html heatmap
89
90 @WHATITDOESFOOTER@
91 </help>
92 <expand macro="citations"/>
93 </tool>