Mercurial > repos > bebatut > humann2

annotate README.md @ 4:c05e34aa939b draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit e5b8f29dde45dddcda6ee283212dd1bdde487f87-dirty
author bebatut
date Fri, 18 Dec 2015 05:05:04 -0500
parents 947012405a6e
children
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 Galaxy wrapper for HUMAnN2
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
2 ==========================
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 HUMAnN is a pipeline for efficiently and accuretly profiling the presence/absence
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
5 and abundance of microbial pathways in a community from metagenomic or
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
6 metatranscriptomic sequencing data. For more information, check the
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
7 [user manual](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
8
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
9 # Installation
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 ## Automated installation
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
12
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
13 On a Galaxy instance, the wrapper can be automatically installed using the
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
14 ToolShed. This will automatically install the dependencies, configure the Galaxy
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
15 instance for the tool and data, ...
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
16
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
17 ## Manual installation
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 For manual installation, the files `humann2.xml` must be put in the `tools/humann2/`
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
20 folder and add the XML files to Galaxy's `tool_conf.xml` (in `config` folder) as
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
21 normal:
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
22
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
23 ```
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
24 <section name="Profile microbial pathways in a community" id="humann2">
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
25 <tool file="humann2/humann2.xml" />
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
26 </section>
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
27 ```
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
28
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
29 MetaPhlAn2 must be installed somewhere on the system path. It can be done using:
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
30
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 planemo dependency_script ~/repositories/galaxytools/tools/humann2/
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
33 bash dep_install.sh
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
34 source env.sh
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
35 ```
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
36
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
37 To test the Galaxy integration, the functional tests can be runned:
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
38
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
39 ```
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
40 ./run_tests.sh -sid humann2
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
41 ```
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
42
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
43 # Bug Reports
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
44
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
45 Any bug can be filed in an issue [here](https://github.com/ASaiM/galaxytools/issues).
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
46
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
47 # Developers
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
48
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
49 A release can be pushed to the test or main "Galaxy Tool Shed", using the following
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
50 Planemo commands (with required Tool Shed access detailed in `~/.planemo.yml`):
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
51
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
52 ```
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
53 planemo shed_update -t testtoolshed --check_diff ~/repositories/galaxytools/tools/humann2/
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
54 ```
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
55
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
56 or:
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
57
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
58 ```
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
59 planemo shed_update -t toolshed --check_diff ~/repositories/galaxytools/tools/humann2/
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
60 ```
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
61
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
62 # License (Apache 2)
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
63
947012405a6e planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/humann2/ commit dd6f3fda4d992efa4a91ee0823ecc3af8a9532d3-dirty
bebatut
parents:
diff changeset
64 This wrapper are released under Apache 2 License. See the [LICENSE file](https://github.com/ASaiM/galaxytools/blob/master/LICENSE) for details