annotate in_development/humann2_rna_dna_norm.xml @ 5:2bf5fcf30e1f draft

planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit e5b8f29dde45dddcda6ee283212dd1bdde487f87-dirty
author bebatut
date Fri, 18 Dec 2015 08:34:43 -0500
parents 947012405a6e
children 0d3d44f13122
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
1 <tool id="humann2_rna_dna_norm" name="Combine metagenomic and metatranscriptomic HUMAnN2 data" version="0.1.0">
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
2 <description></description>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
3
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
4 <requirements>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
5 <requirement type="package" version="2.2.4">bowtie2</requirement>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
6 <requirement type="package" version="2.0">metaphlan2</requirement>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
7 <requirement type="package" version="0.6.13">diamond</requirement>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
8 <requirement type="package" version="2.0">humann2</requirement>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
9 </requirements>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
10
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
11 <stdio>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
12 <exit_code range="1:" />
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
13 </stdio>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
14
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
15 <version_command>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
16 <![CDATA[
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
17 humann2_rna_dna_norm --version
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
18 ]]>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
19 </version_command>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
20
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
21 <command><![CDATA[
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
22 humann2_rna_dna_norm
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
23 --input_dna $input_dna
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
24 --input_rna $input_rna
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
25 --output_basename "combined"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
26 $log_transform.test
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
27 #if $log_transform.test:
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
28 --log_base $log_transform.log_base
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
29 #end if
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
30 ]]></command>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
31
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
32 <inputs>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
33 <param name="input_dna" type="data" format="tsv" label="Metagenomic table"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
34 help="(--input_dna)"/>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
35 <param name="input_rna" type="data" format="tsv" label="Metatranscriptomic table"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
36 help="(--input_rna)"/>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
37
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
38 <conditional name="log_transform">
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
39 <param name='test' type='boolean' checked="false"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
40 truevalue='--log_transform' falsevalue=''
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
41 label="Report log-transformed relative expression values?"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
42 help="(--log_transform)"/>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
43 <when value="--log_transform">
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
44 <param name="log_base" type="integer" min="0" max="10" value="2"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
45 label="Base for log transformation" help="(--log_base)"/>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
46 </when>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
47 <when value=""/>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
48 </conditional>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
49 </inputs>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
50
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
51 <outputs>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
52 <data format="tsv" name="smoothed_dna"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
53 from_work_dir="combined"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
54 label="Smoothed DNA data for ${on_string} (HUMAnN2)" />
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
55 <data format="tsv" name="smoothed_rna"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
56 from_work_dir="combined"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
57 label="Smoothed RNA data for ${on_string} (HUMAnN2)" />
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
58 <data format="tsv" name="normalized_rna"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
59 from_work_dir="combined"
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
60 label="Normalized RNA data for ${on_string} (HUMAnN2)" />
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
61 </outputs>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
62
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
63 <tests>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
64 </tests>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
65
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
66 <help><![CDATA[
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
67 **What it does**
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
68
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
69 This tool normalizes combined meta'omic sequencing data.
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
70
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
71 Given a DNA table and a RNA table, it produces smoothed RNA and DNA values as well as relative expression values. "Smoothing" means substituting a small value in place of a zero or missing value. The Witten-Bell smoothing procedure is used here.
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
72
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
73 If working with stratified data, smoothing is carried out on the stratified values and then community totals are recomputed.
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
74
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
75 The DNA and RNA columns must be 1:1 and in the same order. The units of the table should be count-like (for example, HUMAnN2 gene family abundance files).gene and pathway abundance tables.
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
76
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
77 HUMAnN is a pipeline for efficiently and accuretly profiling the presence/absence and abundance of microbial pathways in a community from metagenomic or metatranscriptomic sequencing data. `Read more about the tool <http://huttenhower.sph.harvard.edu/humann2/manual>`_.
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
78
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
79 ]]></help>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
80
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
81 <citations>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
82 </citations>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
83 </tool>