annotate align_families.xml @ 6:9a0bee12b583 draft default tip

planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
author nick
date Mon, 06 Feb 2017 23:39:11 -0500
parents 4bc49a5769ee
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
1 <?xml version="1.0"?>
6
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
2 <tool id="align_families" name="Du Novo: Align families" version="0.6">
2
ba2a53b970ca planemo upload commit 670b3282d2c120882b956ad617e61369467fb0fe
nick
parents: 1
diff changeset
3 <description>of duplex sequencing reads</description>
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
4 <requirements>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
5 <requirement type="package" version="7.221">mafft</requirement>
6
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
6 <requirement type="package" version="0.6">duplex</requirement>
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
7 <requirement type="set_environment">DUPLEX_DIR</requirement>
4
7f513b9b1b1e Change names to dunovo, use newer Github release.
nick
parents: 3
diff changeset
8 <!-- TODO: require Python 2.7 -->
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
9 </requirements>
6
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
10 <command detect_errors="exit_code">python "\$DUPLEX_DIR/align_families.py" -p \${GALAXY_SLOTS:-1} '$input' &gt; '$output'
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
11 </command>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
12 <inputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
13 <param name="input" type="data" format="tabular" label="Input reads" help="with barcodes, grouped by family"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
14 </inputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
15 <outputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
16 <data name="output" format="tabular"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
17 </outputs>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
18 <tests>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
19 <test>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
20 <param name="input" value="smoke.families.tsv"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
21 <output name="output" file="smoke.families.aligned.tsv"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
22 </test>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
23 <test>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
24 <param name="input" value="families.in.tsv"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
25 <output name="output" file="families.sort.tsv"/>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
26 </test>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
27 </tests>
6
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
28 <citations>
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
29 <citation type="bibtex">@article{Stoler2016,
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
30 author = {Stoler, Nicholas and Arbeithuber, Barbara and Guiblet, Wilfried and Makova, Kateryna D and Nekrutenko, Anton},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
31 doi = {10.1186/s13059-016-1039-4},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
32 issn = {1474-760X},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
33 journal = {Genome biology},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
34 number = {1},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
35 pages = {180},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
36 pmid = {27566673},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
37 publisher = {Genome Biology},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
38 title = {{Streamlined analysis of duplex sequencing data with Du Novo.}},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
39 url = {http://www.ncbi.nlm.nih.gov/pubmed/27566673},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
40 volume = {17},
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
41 year = {2016}
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
42 }</citation>
9a0bee12b583 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9fbe4b8871038d2945fa4b9ee0b5f89cf4e4f494\n'-dirty
nick
parents: 5
diff changeset
43 </citations>
0
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
44 <help>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
45
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
46 **What it does**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
47
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
48 This is for processing duplex sequencing data. It does a multiple sequence alignment on each (single-stranded) family of reads.
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
49
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
50 -----
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
51
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
52 **Input**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
53
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
54 This expects the output format of the "Make families" tool.
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
55
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
56 -----
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
57
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
58 **Output**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
59
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
60 The output is a tabular file where each line corresponds to a (single) read.
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
61
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
62 The columns are::
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
63
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
64 1: barcode (both tags)
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
65 2: tag order in barcode ("ab" or "ba")
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
66 3: read mate ("1" or "2")
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
67 4: read name
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
68 5: read sequence, aligned ("-" for gaps)
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
69 6: read quality scores, aligned (" " for gaps)
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
70
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
71 -----
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
72
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
73 **Alignments**
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
74
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
75 The alignments are done using MAFFT, specifically the command
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
76 ::
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
77
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
78 $ mafft --nuc --quiet family.fa &gt; family.aligned.fa
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
79
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
80 </help>
d2e46adc199e planemo upload commit 35b743e6492923c0e2b1e5e434eaf4e56d268108
nick
parents:
diff changeset
81 </tool>