annotate README.md @ 5:ec4a183cc713 draft

planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
author matthias
date Sun, 05 May 2019 12:37:14 -0400
parents
children 6da167015b3e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
ec4a183cc713 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.
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
2
ec4a183cc713 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
ec4a183cc713 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
ec4a183cc713 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
ec4a183cc713 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
ec4a183cc713 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
ec4a183cc713 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
ec4a183cc713 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
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
10
ec4a183cc713 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
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
12 =========
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
13
ec4a183cc713 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.
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
15
ec4a183cc713 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):
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
17
ec4a183cc713 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)
ec4a183cc713 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)
ec4a183cc713 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)
ec4a183cc713 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)
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
22
ec4a183cc713 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:
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
24
ec4a183cc713 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
ec4a183cc713 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)
ec4a183cc713 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)
ec4a183cc713 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
ec4a183cc713 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)
ec4a183cc713 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)
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
31
ec4a183cc713 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).
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
33
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
34
ec4a183cc713 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
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
36 =====
ec4a183cc713 planemo upload for repository https://github.com/bernt-matthias/mb-galaxy-tools/tree/topic/dada2/tools/dada2 commit 990192685955e9cda0282e348c28ef6462d88a38
matthias
parents:
diff changeset
37
ec4a183cc713 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?
ec4a183cc713 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