Mercurial > repos > iuc > dada2_removebimeradenovo

annotate README.md @ 1:7f8f0e9fcb37 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/dada2 commit a82e4981dac025c909244acd7127c215bdb519a7"
author iuc
date Thu, 05 Dec 2019 17:59:57 -0500
parents 1937c2b4da7a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
1 Wrappers for the core functionality of the dada2 package https://benjjneb.github.io/dada2/index.html.
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
2
1
7f8f0e9fcb37 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit a82e4981dac025c909244acd7127c215bdb519a7"
iuc
parents: 0
diff changeset
3 - assignTaxonomyAddspecies
0
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
4 - filterAndTrim
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
5 - learnErrors
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
6 - dada
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
7 - mergePairs
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
8 - makeSequenceTable
1
7f8f0e9fcb37 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit a82e4981dac025c909244acd7127c215bdb519a7"
iuc
parents: 0
diff changeset
9 - plotComplexity
7f8f0e9fcb37 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit a82e4981dac025c909244acd7127c215bdb519a7"
iuc
parents: 0
diff changeset
10 - plotQualityProfile
0
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
11 - removeBimeraDenovo
1
7f8f0e9fcb37 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit a82e4981dac025c909244acd7127c215bdb519a7"
iuc
parents: 0
diff changeset
12 - seqCounts
0
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
13
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
14 Installation
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
15 ============
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
16
1
7f8f0e9fcb37 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit a82e4981dac025c909244acd7127c215bdb519a7"
iuc
parents: 0
diff changeset
17 A conda release >=4.6 is needed so that the bioconductor-dada2 conda environment can be installed correctly.
7f8f0e9fcb37 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit a82e4981dac025c909244acd7127c215bdb519a7"
iuc
parents: 0
diff changeset
18
0
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
19 The dada2 wrappers can be installed via the toolshed. Since they use datatypes that have been introduced with Galaxy release 19.09 they won't work out of the box for older Galaxy releases.
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
20 In order to run the tools you may either upgrade Galaxy or execute the following two steps:
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
21
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
22 1. `find GALAXY_ROOT/shed_tools/testtoolshed.g2.bx.psu.edu/repos/iuc/ -name "dada2_*xml" -exec sed -i -e 's/profile="19.09"/profile="YOUR_RELEASE"/' {} ;` (replace GALAXY_ROOT and YOUR_RELEASE appropriately)
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
23 2. insert the following lines in `config/datatypes.xml` (just before the line `</registration>`):
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
24 ```
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
25 <datatype extension="dada2_dada" type="galaxy.datatypes.binary:RData" subclass="true" display_in_upload="true" />
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
26 <datatype extension="dada2_errorrates" type="galaxy.datatypes.binary:RData" subclass="true" display_in_upload="true" />
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
27 <datatype extension="dada2_mergepairs" type="galaxy.datatypes.binary:RData" subclass="true" display_in_upload="true" />
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
28 <datatype extension="dada2_sequencetable" type="galaxy.datatypes.tabular:Tabular" mimetype="application/text" subclass="true" display_in_upload="true" />
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
29 <datatype extension="dada2_uniques" type="galaxy.datatypes.tabular:Tabular" mimetype="application/text" subclass="true" display_in_upload="true" />
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
30 ```
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
31
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
32 Datatypes
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
33 =========
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
34
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
35 The dada2 Galaxy wrappers use a few extra data types to ensure that only inputs of the correct type can be used, these datatypes are available from Galaxy release 19.05, for earlier releases they need to be added manually.
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
36
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
37 For the outputs of dada, learnErrors, and mergePairs the following datatypes are used that derive from Rdata (which contains the named list that is returned from the corresponding dada function):
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
38
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
39 - dada2_dada (Rdata: named list, see docs for dada-class)
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
40 - dada2_errorrates (Rdata: named list, see docs for learnErrors)
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
41 - dada2_mergepairs (Rdata: named list, see docs for mergePairs)
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
42
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
43 For the outputs of makeSequenceTable and removeBimeraDenovo the following data types are used which derive from tabular:
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
44
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
45 - dada2_uniques
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
46 -- in R a named integer vector (names are the unique sequences)
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
47 -- in Galaxy written as a table (each row corresponding to a unique sequence, column 1: the sequence, column 2: the count)
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
48 - dada2_sequencetable
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
49 -- in R a named integer matrix (rows = samples, columns = unique sequences)
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
50 -- in Galaxy written as a table (rows = unique sequences, columns = samples)
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
51
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
52 Note the difference between the R and Galaxy representations! The main motivation is that the dada2_sequencetable is analogous to OTU tables as produced for instance by qiime (and it seemed natural to extend this to the uniques which are essentially a sequencetables of single samples).
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
53
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
54 Test data
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
55 =========
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
56
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
57 Test data for `dada2_seqCounts` is generated using planemo's `--update_test_data` argument and manual
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
58 inspection of the test files. In addition a run of the pipeline (using collections) is executed
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
59 manually using `planemo serve` making sure that the entries of the tables are generated in a useful way.
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
60
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
61 In order to have the Collection unzip tool available use `planemo s --galaxy_root GALAXY_ROOT --extra_tools GALAXY_ROOT/lib/galaxy/tools/`
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
62
1937c2b4da7a "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/dada2 commit f8b6b6e72914ad6bcca8423dfa03f59bde80992e"
iuc
parents:
diff changeset
63 All test other test data is generated using the shell script (`gentest.sh`) in test-data