annotate make_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="make_families" name="Du Novo: Make 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>
21
f509cd1d5a78 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fd1625359a101d8a6b0b8d97028cc8be509398f2\n'-dirty
nick
parents: 19
diff changeset
5 <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
6 </requirements>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
7 <!-- TODO: Add dependency on coreutils to get paste? -->
19
e5d1d90c099b planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9101e88acb2d3dc022c47e0663fec1f6b9fa58a5\n'-dirty
nick
parents: 18
diff changeset
8 <version_command>make-consensi.py --version</version_command>
0
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
9 <command detect_errors="exit_code">make-families.sh -t $taglen -i $invariant '$fastq1' '$fastq2' &gt; '$output'
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
10 </command>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
11 <inputs>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
12 <param name="fastq1" type="data" format="fastq" label="Sequencing reads, mate 1"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
13 <param name="fastq2" type="data" format="fastq" label="Sequencing reads, mate 2"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
14 <param name="taglen" type="integer" value="12" min="0" label="Tag length" help="length of each random barcode on the ends of the fragments"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
15 <param name="invariant" type="integer" value="5" min="0" label="Invariant sequence length" help="length of the sequence between the tag and actual sample sequence (the restriction site, normally)"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
16 </inputs>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
17 <outputs>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
18 <data name="output" format="tabular"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
19 </outputs>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
20 <tests>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
21 <test>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
22 <param name="fastq1" value="smoke_1.fq"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
23 <param name="fastq2" value="smoke_2.fq"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
24 <param name="taglen" value="5"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
25 <param name="invariant" value="1"/>
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.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>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
29 <param name="fastq1" value="smoke_1.fq"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
30 <param name="fastq2" value="smoke_2.fq"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
31 <param name="taglen" value="5"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
32 <param name="invariant" value="0"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
33 <output name="output" file="smoke.families.i0.tsv"/>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
34 </test>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
35 </tests>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
36 <help>
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
37
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
38 **What it does**
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 This tool is for processing raw duplex sequencing data, removing the barcodes and grouping by them into families of reads from the same fragment.
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
41
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
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
44 **Output**
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 The output will be a tabular file where each line corresponds to a pair of input reads.
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
47
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
48 The columns are::
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
49
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
50 1: barcode (both tags joined and ordered)
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
51 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
52 3: read1 name
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
53 4: read1 sequence (minus the tag and invariant sequences)
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
54 5: read1 quality scores (minus the same tag and invariant)
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
55 6: read2 name
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
56 7: read2 sequence (minus the tag and invariant sequences)
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
57 8: read2 quality scores (minus the same tag and invariant)
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
58
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 **Barcode creation**
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
62
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
63 For each pair, the tool will remove the tag at the beginning of each read and create a barcode by concatenating the two tags. The order of the tags is determined by a string comparison so that it will make an identical barcode from pairs of either order. The original tag order will be noted in the second column.
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
64
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
65 Since pairs from opposite strands will have the same tags, but in the reverse order, this produces the same barcode for reads from the same fragment, regardless of strand. Then a simple sort will group all reads from the same strand together, separated into strands by the different "order" values.
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 Examples::
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
68
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
69 +---------------+-----------------+
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
70 | input tags | output |
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
71 +-------+-------+-------+---------+
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
72 | read1 | read2 | order | barcode |
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
73 +-------+-------+-------+---------+
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
74 | ATG | CCT | ab | ATGCCT |
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
75 +-------+-------+-------+---------+
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
76 | CCT | ATG | ba | ATGCCT |
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
77 +-------+-------+-------+---------+
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
78
15
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
79 </help>
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
80 <citations>
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
81 <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
82 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
83 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
84 issn = {1474-760X},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
85 journal = {Genome biology},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
86 number = {1},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
87 pages = {180},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
88 pmid = {27566673},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
89 publisher = {Genome Biology},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
90 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
91 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
92 volume = {17},
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
93 year = {2016}
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
94 }</citation>
e87f8aef4535 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'4ee47753d5af62e584de290ae07ca3547aca2637\n'-dirty
nick
parents: 14
diff changeset
95 </citations>
0
548c63893c70 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'fcd6f371638bc29da6dbe22f939f7a5a7f360481\n'-dirty
nick
parents:
diff changeset
96 </tool>