annotate README.md @ 6:9f32a9f91411 draft

planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 72e787011111e0262b8161c3834a6258d7b667bc-dirty
author matthias
date Wed, 08 May 2019 03:50:35 -0400
parents caa2bdb8a431
children 7050480907b5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
1 Wrappers for the core functionality of the dada2 package https://benjjneb.github.io/dada2/index.html.
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
2
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
3 - filterAndTrim
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
4 - derep
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
5 - learnErrors
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
6 - dada
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
7 - mergePairs
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
8 - makeSequenceTable
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
9 - removeBimeraDenovo
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
10
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
11 Datatypes
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
12 =========
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
13
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
14 The dada2 Galaxy wrappers use a few extra data types to ensure that only inputs of the correct type can be used.
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
15
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
16 For the outputs of derep, 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):
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
17
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
18 - dada2_derep (Rdata: named list see docs for derep-class)
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
19 - dada2_dada (Rdata: named list, see docs for dada-class)
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
20 - dada2_errorrates (Rdata: named list, see docs for learnErrors)
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
21 - dada2_mergepairs (Rdata: named list, see docs for mergePairs)
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
22
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
23 For the outputs of makeSequenceTable and removeBimeraDenovo the following data types are used which derive from tabular:
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
24
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
25 - dada2_uniques
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
26 -- in R a named integer vector (names are the unique sequences)
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
27 -- in Galaxy written as a table (each row corresponding to a unique sequence, column 1: the sequence, column 2: the count)
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
28 - dada2_sequencetable
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
29 -- in R a named integer matrix (rows = samples, columns = unique sequences)
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
30 -- in Galaxy written as a table (rows = unique sequences, columns = samples)
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
31
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
32 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).
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
33
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
34
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
35 TODOs
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
36 =====
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
37
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
38 - implememt getUniques tool to view intermediate results?
caa2bdb8a431 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
39 - implement tests for cached reference data