annotate align_families.xml @ 11:0f8e0dc73d1d draft default tip

"planemo upload for repository https://github.com/galaxyproject/dunovo commit dbd33f95b486dc556c435f1b42736b818a2b9802-dirty"
author nick
date Wed, 16 Feb 2022 22:59:00 +0000
parents 9dc43bf7d1db
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
1 <?xml version="1.0"?>
11
0f8e0dc73d1d "planemo upload for repository https://github.com/galaxyproject/dunovo commit dbd33f95b486dc556c435f1b42736b818a2b9802-dirty"
nick
parents: 10
diff changeset
2 <tool id="align_families" name="Du Novo: Align families" version="3.0.2">
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
3 <description>of duplex sequencing reads</description>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
4 <requirements>
11
0f8e0dc73d1d "planemo upload for repository https://github.com/galaxyproject/dunovo commit dbd33f95b486dc556c435f1b42736b818a2b9802-dirty"
nick
parents: 10
diff changeset
5 <requirement type="package" version="3.0.2">dunovo</requirement>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
6 </requirements>
7
e7b88ffb8294 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'9101e88acb2d3dc022c47e0663fec1f6b9fa58a5\n'-dirty
nick
parents: 6
diff changeset
7 <version_command>align-families.py --version</version_command>
10
9dc43bf7d1db planemo upload for repository https://github.com/galaxyproject/dunovo commit b'230f018da2c0bc4eedc72e0f70eac0df1e85ebdb\n'-dirty
nick
parents: 9
diff changeset
8 <command detect_errors="exit_code">align-families.py $check_ids --aligner $aligner --galaxy $phone --processes \${GALAXY_SLOTS:-1} '$input' &gt; '$output'
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
9 </command>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
10 <inputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
11 <param name="input" type="data" format="tabular" label="Input reads" help="with barcodes, grouped by family"/>
4
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
12 <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.">
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
13 <option value="kalign">Kalign2</option>
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
14 <option value="mafft">MAFFT</option>
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
15 </param>
10
9dc43bf7d1db planemo upload for repository https://github.com/galaxyproject/dunovo commit b'230f018da2c0bc4eedc72e0f70eac0df1e85ebdb\n'-dirty
nick
parents: 9
diff changeset
16 <param name="check_ids" type="boolean" truevalue="" falsevalue="--no-check-ids" checked="True" label="Check read names" help="Make sure reads are properly paired up. The job will fail if there is a pair of reads where their ids aren't identical (minus any ending /1 or /2)."/>
4
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
17 <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
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
18 </inputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
19 <outputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
20 <data name="output" format="tabular"/>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
21 </outputs>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
22 <tests>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
23 <test>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
24 <param name="input" value="smoke.families.tsv"/>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
25 <output name="output" file="smoke.families.aligned.tsv"/>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
26 </test>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
27 <test>
4
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
28 <param name="input" value="families.sort.tsv"/>
11
0f8e0dc73d1d "planemo upload for repository https://github.com/galaxyproject/dunovo commit dbd33f95b486dc556c435f1b42736b818a2b9802-dirty"
nick
parents: 10
diff changeset
29 <param name="check_ids" value="--no-check-ids"/>
4
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
30 <output name="output" file="families.msa.tsv"/>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
31 </test>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
32 </tests>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
33 <help>
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
34
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
35 **What it does**
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
36
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\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.
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
38
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
39 -----
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
40
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
41 **Input**
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
42
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
43 This expects the output format of the "Make families" tool.
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
44
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
45 -----
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
46
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
47 **Output**
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
48
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
49 The output is a tabular file where each line corresponds to a (single) read.
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
50
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
51 The columns are::
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
52
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
53 1: barcode (both tags)
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
54 2: tag order in barcode ("ab" or "ba")
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
55 3: read mate ("1" or "2")
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
56 4: read name
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
57 5: read sequence, aligned ("-" for gaps)
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
58 6: read quality scores, aligned (" " for gaps)
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
59
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
60 -----
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
61
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
62 **Alignments**
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
63
8
658eefb99fd7 planemo upload for repository https://github.com/galaxyproject/dunovo commit b'7d364d2b3f4fd9a7787165a883efa122b326d4c2\n'-dirty
nick
parents: 7
diff changeset
64 When "MAFFT" is selected as the multiple sequence aligner, the alignments are done with the command
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
65 ::
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
66
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
67 $ mafft --nuc --quiet family.fa &gt; family.aligned.fa
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
68
4
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
69 </help>
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
70 <citations>
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
71 <citation type="bibtex">@article{Stoler2016,
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
72 author = {Stoler, Nicholas and Arbeithuber, Barbara and Guiblet, Wilfried and Makova, Kateryna D and Nekrutenko, Anton},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
73 doi = {10.1186/s13059-016-1039-4},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
74 issn = {1474-760X},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
75 journal = {Genome biology},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
76 number = {1},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
77 pages = {180},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
78 pmid = {27566673},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
79 publisher = {Genome Biology},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
80 title = {{Streamlined analysis of duplex sequencing data with Du Novo.}},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
81 url = {http://www.ncbi.nlm.nih.gov/pubmed/27566673},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
82 volume = {17},
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
83 year = {2016}
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
84 }</citation>
5fbeaa41b223 Update to Du Novo 2.0.6.
nick
parents: 3
diff changeset
85 </citations>
0
f875256c722e planemo upload for repository https://github.com/galaxyproject/dunovo commit b'd00f828e5768c5fac3e382b9d12f34bbdf9019e9\n'-dirty
nick
parents:
diff changeset
86 </tool>