annotate README.md @ 13:13d85ceb0d4a draft default tip

planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit df2dfeb75f88b326f567cab8df4e6c4a7f2e548c
author matthias
date Tue, 15 Oct 2019 07:25:03 -0400
parents ce4309b1defa
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
f8baae6433df 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.
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
2
f8baae6433df 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
f8baae6433df 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
f8baae6433df 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
f8baae6433df 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
f8baae6433df 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
f8baae6433df 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
f8baae6433df 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
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
10
f8baae6433df 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
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
12 =========
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
13
10
ce4309b1defa planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit a54770771e567c7ad8a9dd75cc4689c3935ef11c
matthias
parents: 5
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, these datatypes are available from Galaxy release 19.05, for earlier releases they need to be added manually.
5
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
15
f8baae6433df 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):
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
17
f8baae6433df 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)
f8baae6433df 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)
f8baae6433df 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)
f8baae6433df 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)
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
22
f8baae6433df 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:
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
24
f8baae6433df 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
f8baae6433df 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)
f8baae6433df 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)
f8baae6433df 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
f8baae6433df 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)
f8baae6433df 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)
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
31
f8baae6433df 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).
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
33
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
34
f8baae6433df 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
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
36 =====
f8baae6433df planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
37
10
ce4309b1defa planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit a54770771e567c7ad8a9dd75cc4689c3935ef11c
matthias
parents: 5
diff changeset
38 - implement getUniques tool to view intermediate results?