annotate skesa.xml @ 9:9e6af7620b3c draft

Uploaded
author estrain
date Thu, 16 Aug 2018 13:54:18 -0400
parents 2364f2fcec7d
children ddb2fec6cf7a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
1 <tool id="skesa" name="skesa" version="0.1">
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
2 <requirements>
2
2f4443bea09d planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 1
diff changeset
3 <requirement type="package" version="2.2">skesa</requirement>
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
4 </requirements>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
5 <command detect_errors="exit_code"><![CDATA[
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
6 #if $jobtype.select != "cl"
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
7 skesa
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
8 #if $jobtype.select == "srr"
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
9 -sra_run $srrnum
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
10 #else if $jobtype.select == "asm"
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
11 --fasta $draft
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
12 #else if $jobtype.select == "se"
4
15be58c254f5 Uploaded
estrain
parents: 3
diff changeset
13 --fastq $fastq1
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
14 #else if $jobtype.select == "pe"
4
15be58c254f5 Uploaded
estrain
parents: 3
diff changeset
15 --fastq $fastq1,$fastq2 --use_paired_ends
7
15d00ca53144 Uploaded
estrain
parents: 6
diff changeset
16 #else if $jobtype.select == "rp"
6
f9b8095f18fe Uploaded
estrain
parents: 5
diff changeset
17 --fastq $pairedfiles.forward,$pairedfiles.reverse --use_paired_ends
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
18 #end if
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
19 #if $cores != 0
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
20 --cores $cores
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
21 #end if
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
22 --memory $memory > results.skesa.fasta
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
23 #end if
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
24
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
25 ]]></command>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
26 <inputs>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
27 <conditional name="jobtype">
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
28 <when value="srr">
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
29 <param name="srrnum" type="text" label="Sra run number"/>
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
30 </when>
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
31 <param name="select" type="select" label="Assembly or FASTQ Reads?">
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
32 <option value="sra">SRR number</option>
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
33 <option value="asm">Genome Assembly</option>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
34 <option value="se">Single-End Reads</option>
6
f9b8095f18fe Uploaded
estrain
parents: 5
diff changeset
35 <option value="pe">Paired-End Reads (Separate Files)</option>
f9b8095f18fe Uploaded
estrain
parents: 5
diff changeset
36 <option value="rp">Paired-End Reads (Paired Data Set)</option>
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
37 <option value="cl">Collection of Reads</option>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
38 </param>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
39 <when value="asm">
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
40 <param name="draft" type="data" format="fasta" label="FASTA" />
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
41 </when>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
42 <when value="se">
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
43 <param name="fastq1" type="data" format="fastq" label="FASTQ" />
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
44 </when>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
45 <when value="pe">
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
46 <param name="fastq1" type="data" format="fastq" label="FASTQ" />
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
47 <param name="fastq2" type="data" format="fastq" label="FASTQ" />
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
48 </when>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
49 <when value="cl">
1
abe89c222f28 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 0
diff changeset
50 <param type="data_collection" name="collection_files" format="fastq" collection_type="list" label="FASTQS: Must be a Data Set list built from multiple fastq files" />
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
51 </when>
6
f9b8095f18fe Uploaded
estrain
parents: 5
diff changeset
52 <when value="rp">
9
9e6af7620b3c Uploaded
estrain
parents: 8
diff changeset
53 <param type="data_collection" collection_type="paired" name="pairedfiles" format="fastq" label="FASTQS: Must be a paired set of forward and reverse fastq files" />
6
f9b8095f18fe Uploaded
estrain
parents: 5
diff changeset
54 </when>
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
55 </conditional>
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
56 <param name="memory" type="integer" label="Memory available (GB) [integer]" value="16" />
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
57 <param name="cores" type="integer" label="Number of cores to use (default all) [integer]" value="0" />
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
58 <param name="kmer" type="integer" label="Minimal kmer length for assembly [default 21] if non are specified " value="0" />
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
59 <param name="min_count" type="integer" label="Minimal count for kmers retained for comparing alternate choices [integer]" value="0" />
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
60
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
61 </inputs>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
62 <outputs>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
63 <data format="fasta" label="skesa Results" name="${input.name}.skesa.fasta" from_work_dir="*.fasta"/>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
64 </outputs>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
65
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
66 <help><![CDATA[
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
67
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
68 **Usage: skesa**
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
69
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
70 **INPUT**
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
71
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
72 A fasta assembly or single or paired end reads test or data set list of fastqs
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
73
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
74 **Memory available**
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
75
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
76 --memory arg (=32) Memory available (GB) [integer]
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
77
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
78
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
79 **Number of cores**
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
80
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
81 --cores arg (=0) Number of cores to use (default all) [integer]
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
82
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
83 https://github.com/ncbi/ngs-tools/tree/master/tools/skesa/
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
84
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
85 ]]></help>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
86 <citations>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
87 <citation type="bibtex">
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
88 @misc{pope_dashnow_zobel_holt_raven_schultz_inouye_tomita_2014,
5
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
89 title={skesa: eSKESA is a de-novo sequence read assembler for cultured single isolate genomes
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
90 based on DeBruijn graphs. It uses conservative heuristics and is designed to
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
91 create breaks at repeat regions in the genome. This leads to excellent sequence
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
92 quality but not necessarily a large N50 statistic. It is a multi-threaded
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
93 application that scales well with the number of processors. For different runs
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
94 with the same inputs, including the order of reads, the order and orientation
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
95 of contigs in the output is deterministic. },
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
96 url={https://github.com/ncbi/ngs-tools/tree/master/tools/skesa/},
b82a1b3c5b61 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 4
diff changeset
97 author={National Center for Biotechnology Information },
0
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
98 }</citation>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
99 </citations>
5bba9b6003cb planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents:
diff changeset
100 </tool>