annotate skesa.xml @ 22:9448df7c25a0 draft

Uploaded
author estrain
date Mon, 15 Oct 2018 17:12:13 -0400
parents 8bafd3d18864
children e2b708d5c0d3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
1 <tool id="skesa" name="skesa" version="0.23">
14
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
2 <requirements>
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
3 <requirement type="package" version="2.3.0">skesa</requirement>
14
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
4 </requirements>
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
5 <command detect_errors="exit_code"><![CDATA[
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
6
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
7 skesa
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
8
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
9 #if $jobtype.select == "fasta_single"
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
10 #set outname = $jobtype.fasta.name
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
11 --fasta $jobtype.fasta
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
12 #else if $jobtype.select == "fastq_single"
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
13 #set outname = $jobtype.fastq1.name
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
14 --fastq $jobtype.fastq1
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
15 #else if $jobtype.select == "fastq_fr"
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
16 #set outname = $jobtype.fastq1.name
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
17 --fastq $jobtype.fastq1 --fastq $jobtype.fastq2
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
18 #else if $jobtype.select == "fastq_pair"
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
19 #set outname = $jobtype.coll.name
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
20 --fastq $jobtype.coll.forward --fastq $jobtype.coll.reverse
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
21 #end if
21
8bafd3d18864 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 20
diff changeset
22
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
23 #if $options.select=="advanced"
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
24 #if $options.cores
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
25 --cores $options.cores
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
26 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
27 #if $options.memory
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
28 --memory $options.memory
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
29 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
30 #if $options.hash_count
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
31 --hash_count
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
32 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
33 #if $options.estimated_kmers
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
34 --estimated_kmers $options.estimated.kmers
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
35 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
36 #if $options.skip
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
37 --skip_bloom_filter
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
38 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
39 #if $options.kmer
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
40 --kmer $options.kmer
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
41 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
42 #if $options.min_count
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
43 --min_count $options.min_count
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
44 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
45 #if $options.max_kmer_count
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
46 --max_kmer_count $options.max_kmer_count
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
47 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
48 #if $options.vector_percent
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
49 --vector_percent $options.vector_percent
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
50 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
51 #if $options.insert_size
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
52 --insert_size $options.insert.size
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
53 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
54 #if $options.steps
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
55 --steps $options.steps
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
56 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
57 #if $options.fraction
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
58 --fraction $options.fraction
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
59 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
60 #if $options.max_snp_len
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
61 --max_snp_len $options.max_snp_len
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
62 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
63 #if $options.min_contig
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
64 --min_contig $options.min_contig
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
65 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
66 #if $options.allow_snps
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
67 --allow_snps
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
68 #end if
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
69 #else if $options.select =="basic"
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
70 --cores \${GALAXY_SLOTS:-4}
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
71 --memory 16
14
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
72 #end if
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
73
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
74 > ${outname}.fasta
14
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
75
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
76 ]]></command>
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
77 <inputs>
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
78 <conditional name="jobtype">
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
79 <param name="select" type="select" label="Select Input">
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
80 <option value="fasta_single">Single FASTA</option>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
81 <option value="fastq_single">Single FASTQ</option>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
82 <option value="fastq_fr">Forward and Reverse FASTQ</option>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
83 <option value="fastq_pair">Paired FASTQ Collection</option>
14
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
84 </param>
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
85 <when value="fasta_single">
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
86 <param name="fasta" type="data" format="fasta" label="FASTA" />
14
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
87 </when>
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
88 <when value="fastq_single">
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
89 <param name="fastq1" type="data" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" label="FASTQ" />
21
8bafd3d18864 planemo upload commit cd1454c40a43ad9da3d59e6ba8359318fc772c43-dirty
cstrittmatter
parents: 20
diff changeset
90 </when>
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
91 <when value="fastq_fr">
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
92 <param name="fastq1" type="data" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" label="Forward FASTQ" />
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
93 <param name="fastq2" type="data" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" label="Reverse FASTQ" />
14
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
94 </when>
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
95 <when value="fastq_pair">
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
96 <param name="coll" label="Paired FASTQ" type="data_collection" format="fastq,fastqsanger,fastq.gz,fastqsanger.gz,fastq.bz2,fastqsanger.bz2" collection_type="paired" />
14
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
97 </when>
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
98 </conditional>
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
99
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
100 <conditional name="options">
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
101 <param name="select" type="select" label="Options Type">
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
102 <option value="basic">Basic</option>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
103 <option value="advanced">Advanced</option>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
104 </param>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
105 <when value="advanced">
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
106 <param name="cores" type="integer" label="Number of cores to use" value="1"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
107 <param name="memory" type="integer" label="Memory available (GB, only for sorted counter)" value="16"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
108 <param name="hash_count" type="boolean" label="hash counter"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
109 <param name="estimated_kmers" type="integer" label="Estimated number of unique kmers for bloom filter" value="100"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
110 <param name="skip" type="boolean" label="skip bloom filter, use estimate kmers as the hash"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
111 <param name="kmer" type="integer" label="Minimal kmer length for assembly" value="21"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
112 <param name="min_count" type="integer" label="Minimal count for kmers retained for comparing alternate choices" value=""/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
113 <param name="max_kmer_count" type="integer" label="Minimum acceptable average count for estimating the maximal kmer length in reads" value=""/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
114 <param name="vector_percent" type="float" label="Count for vectors as a fraction of the read number (1=disabled)" value="1">
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
115 <validator type="in_range" message="Must be float(0,1)." min="0" max="1"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
116 </param>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
117 <param name="insert_size" type="integer" label="Expected insert size for paired reads (if not provided, it will be estimated)" value=""/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
118 <param name="steps" type="integer" label="Number of assembly iterations from minimal to maximal kmer length in reads" value="11"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
119 <param name="fraction" type="float" label="Maximum noise to signal ratio acceptable for extension" value="0.1">
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
120 <validator type="in_range" message="Must be float(0,1)." min="0" max="1"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
121 </param>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
122 <param name="max_snp_len" type="integer" label="Maximal snp length" value="150"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
123 <param name="min_contig" type="integer" label="Minimal contig length reported in output" value="200"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
124 <param name="allow_snps" type="boolean" label="Turn SNP discovery" value="false"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
125 </when>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
126 <when value="basic"/>
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
127 </conditional>
14
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
128 </inputs>
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
129 <outputs>
22
9448df7c25a0 Uploaded
estrain
parents: 21
diff changeset
130 <data format="fasta" name="results.skesa.fasta" label="${tool.name} on ${on_string}: Contigs" from_work_dir="*.fasta"/>
14
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
131 </outputs>
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
132
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
133 <help><![CDATA[
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
134
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
135 ]]></help>
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
136 <citations>
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
137 <citation type="bibtex">
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
138 @misc{pope_dashnow_zobel_holt_raven_schultz_inouye_tomita_2014,
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
139 title={skesa: eSKESA is a de-novo sequence read assembler for cultured single isolate genomes
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
140 based on DeBruijn graphs. It uses conservative heuristics and is designed to
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
141 create breaks at repeat regions in the genome. This leads to excellent sequence
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
142 quality but not necessarily a large N50 statistic. It is a multi-threaded
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
143 application that scales well with the number of processors. For different runs
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
144 with the same inputs, including the order of reads, the order and orientation
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
145 of contigs in the output is deterministic. },
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
146 url={https://github.com/ncbi/ngs-tools/tree/master/tools/skesa/},
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
147 author={National Center for Biotechnology Information },
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
148 }</citation>
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
149 </citations>
1581b4e8d993 Uploaded
estrain
parents:
diff changeset
150 </tool>