Mercurial > repos > bebatut > metaphlan_2

annotate README.md @ 0:8b151cff43e0 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/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
author bebatut
date Thu, 17 Dec 2015 04:03:29 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
1 Galaxy wrapper for MetaPhlAn2
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
2 =============================
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
3
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
4 MetaPhlAn is a computational tool for profiling the composition of microbial
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
5 communities (Bacteria, Archaea, Eukaryotes and Viruses) from metagenomic shotgun
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
6 sequencing data with species level resolution. For more information, check the
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
7 [user manual](https://bitbucket.org/biobakery/metaphlan2)
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
8
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
9 # Installation
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
10
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
11 ## Automated installation
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
12
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
13 On a Galaxy instance, the wrapper can be automatically installed using the
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
14 ToolShed. This will automatically install the dependencies, configure the Galaxy
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
15 instance for the tool and data, ...
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
16
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
17 ## Manual installation
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
18
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
19 For manual installation, the files `metaphlan2.xml` must be put in the `tools/metaphlan2/`
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
20 folder and add the XML files to Galaxy's `tool_conf.xml` (in `config` folder) as
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
21 normal:
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
22
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
23 ```
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
24 <section name="Profile microbial community composition" id="metaphlan2">
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
25 <tool file="metaphlan2/metaphlan2.xml" />
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
26 </section>
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
27 ```
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
28
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
29 MetaPhlAn2 must be installed somewhere on the system path. It can be done using:
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
30
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
31 ```
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
32 planemo dependency_script ~/repositories/galaxytools/tools/metaphlan2/
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
33 bash dep_install.sh
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
34 source env.sh
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
35 ```
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
36
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
37 To test the Galaxy integration, the functional tests can be runned:
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
38
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
39 ```
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
40 ./run_tests.sh -sid metaphlan2
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
41 ```
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
42
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
43 # Bug Reports
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
44
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
45 Any bug can be filed in an issue [here](https://github.com/ASaiM/galaxytools/issues).
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
46
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
47 # Developers
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
48
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
49 A release can be pushed to the test or main "Galaxy Tool Shed", using the following
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
50 Planemo commands (with required Tool Shed access detailed in `~/.planemo.yml`):
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
51
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
52 ```
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
53 planemo shed_update -t testtoolshed --check_diff ~/repositories/galaxytools/tools/metaphlan2/
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
54 ```
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
55
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
56 or:
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
57
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
58 ```
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
59 planemo shed_update -t toolshed --check_diff ~/repositories/galaxytools/tools/metaphlan2/
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
60 ```
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
61
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
62 # License (Apache 2)
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-dirty
bebatut
parents:
diff changeset
63
8b151cff43e0 planemo upload for repository https://github.com/ASaiM/galaxytools/tree/master/tools/metaphlan2/ commit 89a1d80e981c147c87c892384afd8411dccfd8a1-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