annotate align_families.xml @ 21:f509cd1d5a78 draft

planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fd1625359a101d8a6b0b8d97028cc8be509398f2\n'-dirty
author nick
date Thu, 04 Jan 2018 23:55:06 -0500
parents e5d1d90c099b
children db602e459536
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
1 <?xml version="1.0"?>
21
f509cd1d5a78 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fd1625359a101d8a6b0b8d97028cc8be509398f2\n'-dirty
nick
parents: 19
diff changeset
2 <tool id="align_families" name="Du Novo: Align families" version="2.0.10">
0
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
3 <description>of duplex sequencing reads</description>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
4 <requirements>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
5 <requirement type="package" version="7.221">mafft</requirement>
21
f509cd1d5a78 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fd1625359a101d8a6b0b8d97028cc8be509398f2\n'-dirty
nick
parents: 19
diff changeset
6 <requirement type="package" version="2.0.10">dunovo</requirement>
0
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
7 <!-- TODO: require Python 2.7 -->
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
8 </requirements>
19
e5d1d90c099b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9101e88acb2d3dc022c47e0663fec1f6b9fa58a5\n'-dirty
nick
parents: 18
diff changeset
9 <version_command>align-families.py --version</version_command>
e5d1d90c099b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9101e88acb2d3dc022c47e0663fec1f6b9fa58a5\n'-dirty
nick
parents: 18
diff changeset
10 <command detect_errors="exit_code">align-families.py --aligner $aligner --galaxy $phone --processes \${GALAXY_SLOTS:-1} '$input' &gt; '$output'
0
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
11 </command>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
12 <inputs>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
13 <param name="input" type="data" format="tabular" label="Input reads" help="with barcodes, grouped by family"/>
15
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
14 <param name="aligner" type="select" value="mafft" label="Multiple sequence aligner" help="MAFFT is the original aligner Du Novo was published with in 2016. Kalign is much faster and has similar accuracy.">
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
15 <option value="kalign">Kalign2</option>
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
16 <option value="mafft">MAFFT</option>
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
17 </param>
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
18 <param name="phone" type="boolean" truevalue="--phone-home" falsevalue="" checked="False" label="Send usage data" help="Report helpful usage data to the developer, to better understand the use cases and performance of the tool. The only data which will be recorded is the name and version of the tool, the size of the input data, the number of processes used, the time and memory taken to process it, the alignment algorithm selected, and the IP address of the machine running it. Also, if the tool fails, it will report the name of the exception thrown and the line of code it occurred in. The names of the input and output datasets are not sent. All the reporting and recording code is available at https://github.com/NickSto/ET."/>
0
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
19 </inputs>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
20 <outputs>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
21 <data name="output" format="tabular"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
22 </outputs>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
23 <tests>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
24 <test>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
25 <param name="input" value="smoke.families.tsv"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
26 <output name="output" file="smoke.families.aligned.tsv"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
27 </test>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
28 <test>
15
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
29 <param name="input" value="families.sort.tsv"/>
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
30 <output name="output" file="families.msa.tsv"/>
0
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
31 </test>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
32 </tests>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
33 <help>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
34
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
35 **What it does**
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
36
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
37 This is for processing duplex sequencing data. It does a multiple sequence alignment on each (single-stranded) family of reads.
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
38
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
39 -----
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
40
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
41 **Input**
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
42
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
43 This expects the output format of the "Make families" tool.
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
44
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
45 -----
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
46
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
47 **Output**
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
48
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
49 The output is a tabular file where each line corresponds to a (single) read.
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
50
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
51 The columns are::
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
52
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
53 1: barcode (both tags)
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
54 2: tag order in barcode ("ab" or "ba")
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
55 3: read mate ("1" or "2")
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
56 4: read name
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
57 5: read sequence, aligned ("-" for gaps)
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
58 6: read quality scores, aligned (" " for gaps)
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
59
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
60 -----
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
61
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
62 **Alignments**
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
63
21
f509cd1d5a78 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fd1625359a101d8a6b0b8d97028cc8be509398f2\n'-dirty
nick
parents: 19
diff changeset
64 When "MAFFT" is selected as the multiple sequence aligner, the alignments are done with the command
0
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
65 ::
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
66
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
67 $ mafft --nuc --quiet family.fa &gt; family.aligned.fa
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
68
15
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
69 </help>
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
70 <citations>
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
71 <citation type="bibtex">@article{Stoler2016,
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
72 author = {Stoler, Nicholas and Arbeithuber, Barbara and Guiblet, Wilfried and Makova, Kateryna D and Nekrutenko, Anton},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
73 doi = {10.1186/s13059-016-1039-4},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
74 issn = {1474-760X},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
75 journal = {Genome biology},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
76 number = {1},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
77 pages = {180},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
78 pmid = {27566673},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
79 publisher = {Genome Biology},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
80 title = {{Streamlined analysis of duplex sequencing data with Du Novo.}},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
81 url = {http://www.ncbi.nlm.nih.gov/pubmed/27566673},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
82 volume = {17},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
83 year = {2016}
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
84 }</citation>
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
85 </citations>
0
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
86 </tool>