comparison gffread.xml @ 2:12aeae6d8587 draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tool_collections/cufflinks/gffread commit 3bc5271145f939d85bb709fc95197be66b348328
author devteam
date Tue, 07 Jun 2016 17:58:15 -0400
parents 48fe74f391ab
children 9f243677c4c6
comparison
equal deleted inserted replaced
1:48fe74f391ab 2:12aeae6d8587
16 <param name="ref_filtering" type="select" display="checkboxes" multiple="true" label="reference based filters"> 16 <param name="ref_filtering" type="select" display="checkboxes" multiple="true" label="reference based filters">
17 <option value="-N">discard multi-exon mRNAs that have any intron with a non-canonical splice site consensus, i.e. not GT-AG, GC-AG or AT-AC (-N)</option> 17 <option value="-N">discard multi-exon mRNAs that have any intron with a non-canonical splice site consensus, i.e. not GT-AG, GC-AG or AT-AC (-N)</option>
18 <option value="-J">discard any mRNAs that either lack initial START codon or the terminal STOP codon, or have an in-frame stop codon (-J)</option> 18 <option value="-J">discard any mRNAs that either lack initial START codon or the terminal STOP codon, or have an in-frame stop codon (-J)</option>
19 <option value="-V">discard any mRNAs with CDS having in-frame stop codons (-V)</option> 19 <option value="-V">discard any mRNAs with CDS having in-frame stop codons (-V)</option>
20 <option value="-H">check and adjust the starting CDS phase if the original phase leads to a translation with an in-frame stop codon (-H with -V)</option> 20 <option value="-H">check and adjust the starting CDS phase if the original phase leads to a translation with an in-frame stop codon (-H with -V)</option>
21 <!-- gffread bug: B not in missing from param to the arg parser 21 <!-- gffread bug: B not in missing from param to the arg parser
22 <option value="-B">single-exon transcripts are also checked on the opposite strand (-B with -V)</option> 22 <option value="-B">single-exon transcripts are also checked on the opposite strand (-B with -V)</option>
23 --> 23 -->
24 </param> 24 </param>
25 </xml> 25 </xml>
26 <xml name="trackname"> 26 <xml name="trackname">
52 <command> 52 <command>
53 <![CDATA[ 53 <![CDATA[
54 #if $reference_genome.source == 'history': 54 #if $reference_genome.source == 'history':
55 ln -s $reference_genome.genome_fasta genomeref.fa && 55 ln -s $reference_genome.genome_fasta genomeref.fa &&
56 #end if 56 #end if
57 gffread $input 57 gffread $input
58 #if $reference_genome.source == 'cached': 58 #if $reference_genome.source == 'cached':
59 -g "${reference_genome.fasta_indexes.fields.path}" 59 -g "${reference_genome.fasta_indexes.fields.path}"
60 #if $reference_genome.ref_filtering and str($reference_genome.ref_filtering) != '': 60 #if $reference_genome.ref_filtering and str($reference_genome.ref_filtering) != '':
61 #echo ' '.join(str($reference_genome.ref_filtering).split(',')) 61 #echo ' '.join(str($reference_genome.ref_filtering).split(','))
62 #end if 62 #end if
119 <option value="-U">discard single-exon transcripts (-U)</option> 119 <option value="-U">discard single-exon transcripts (-U)</option>
120 <option value="-C">coding only: discard mRNAs that have no CDS feature (-C)</option> 120 <option value="-C">coding only: discard mRNAs that have no CDS feature (-C)</option>
121 <option value="-G">only parse additional exon attributes from the first exon and move them to the mRNA level (useful for GTF input) (-G)</option> 121 <option value="-G">only parse additional exon attributes from the first exon and move them to the mRNA level (useful for GTF input) (-G)</option>
122 <option value="-O">process also non-transcript GFF records (by default non-transcript records are ignored) (-O)</option> 122 <option value="-O">process also non-transcript GFF records (by default non-transcript records are ignored) (-O)</option>
123 <option value="--no-pseudo">filter out records matching the 'pseudo' keyword (--no-pseudo)</option> 123 <option value="--no-pseudo">filter out records matching the 'pseudo' keyword (--no-pseudo)</option>
124 </param> 124 </param>
125 <conditional name="region"> 125 <conditional name="region">
126 <param name="region_filter" type="select" label="Filter by genome region"> 126 <param name="region_filter" type="select" label="Filter by genome region">
127 <option value="none">No</option> 127 <option value="none">No</option>
128 <option value="filter">Yes</option> 128 <option value="filter">Yes</option>
129 </param> 129 </param>
130 <when value="none"/> 130 <when value="none"/>
131 <when value="filter"> 131 <when value="filter">
132 <param name="range" type="text" value="" label="Only show transcripts overlapping coordinate range"> 132 <param name="range" type="text" value="" label="Only show transcripts overlapping coordinate range">
133 <help><![CDATA[ 133 <help><![CDATA[
134 (-r [['strand']'chr':]'start'..'end') <br> 134 (-r [['strand']'chr':]'start'..'end') <br>
135 examples: <br> 135 examples: <br>
136 1000..500000 <br> 136 1000..500000 <br>
137 chr1:1000..500000 <br> 137 chr1:1000..500000 <br>
138 +chr1:1000..500000 <br> 138 +chr1:1000..500000 <br>
139 -chr1:1000..500000 139 -chr1:1000..500000
140 ]]> 140 ]]>
141 </help> 141 </help>
142 <validator type="regex">(([+-])?(\w+:))?\d+\.\.\d+</validator> 142 <validator type="regex">(([+-])?(\w+:))?\d+\.\.\d+</validator>
143 </param> 143 </param>
144 <param name="discard_partial" type="boolean" truevalue="-R" falsevalue="" check="false" 144 <param name="discard_partial" type="boolean" truevalue="-R" falsevalue="" check="false"
145 label="discard all transcripts that are not fully contained within the given range" help="(-R)"/> 145 label="discard all transcripts that are not fully contained within the given range" help="(-R)"/>
146 </when> 146 </when>
147 </conditional> 147 </conditional>
148 <param name="maxintron" type="integer" value="" optional="true" min="0" label="Filter out transcipts with large introns" 148 <param name="maxintron" type="integer" value="" optional="true" min="0" label="Filter out transcipts with large introns"
149 help="If set, discard transcripts having an intron larger (-i max_intron)"/> 149 help="If set, discard transcripts having an intron larger (-i max_intron)"/>
150 <param name="chr_replace" type="data" format="tabular" optional="true" label="Replace reference sequence names" > 150 <param name="chr_replace" type="data" format="tabular" optional="true" label="Replace reference sequence names" >
151 <help><![CDATA[(-m chr_replace) <br> 151 <help><![CDATA[(-m chr_replace) <br>
152 chr_replace is a reference sequence replacement table consisting of 2 columns: "original_ref_ID" "new_ref_ID"<br> 152 chr_replace is a reference sequence replacement table consisting of 2 columns: "original_ref_ID" "new_ref_ID"<br>
153 It is useful for switching between Ensembl and UCSC naming conventions <br> 153 It is useful for switching between Ensembl and UCSC naming conventions <br>
154 NOTE: GFF records on reference sequences that are not found among the "original_ref_ID" entries in this file will be filtered out 154 NOTE: GFF records on reference sequences that are not found among the "original_ref_ID" entries in this file will be filtered out
155 ]]> 155 ]]>
156 </help> 156 </help>
157 </param> 157 </param>
158 158
159 <!-- Although documented, does not appear to be used in the gffread code 159 <!-- Although documented, does not appear to be used in the gffread code
160 <param name="seq_info" type="data" format="tabular" optional="true" label="Use the description field as the value for a 'descr' attribute to the GFF record"> 160 <param name="seq_info" type="data" format="tabular" optional="true" label="Use the description field as the value for a 'descr' attribute to the GFF record">
161 <help> 161 <help>
162 (-s seq_info.fsize -A) useful with mRNA/EST/protein mappings &lt;br&gt; 162 (-s seq_info.fsize -A) useful with mRNA/EST/protein mappings &lt;br&gt;
163 seq_info input file is a 3 column tab-delimited file providing this info for each of the mapped sequences: &lt;br&gt; 163 seq_info input file is a 3 column tab-delimited file providing this info for each of the mapped sequences: &lt;br&gt;
164 "seq-name" "seq-length" "seq-description" &lt;br&gt; 164 "seq-name" "seq-length" "seq-description" &lt;br&gt;
165 </help> 165 </help>
166 </param> 166 </param>
167 --> 167 -->
168 168
169 <!-- merging --> 169 <!-- merging -->
170 <conditional name="merging"> 170 <conditional name="merging">
171 <param name="merge_sel" type="select" label="Transcript merging" help="(-M/--merge or --cluster-only)"> 171 <param name="merge_sel" type="select" label="Transcript merging" help="(-M/--merge or --cluster-only)">
199 </param> 199 </param>
200 <expand macro="ref_filtering_select" /> 200 <expand macro="ref_filtering_select" />
201 <expand macro="fasta_output_select" /> 201 <expand macro="fasta_output_select" />
202 </when> 202 </when>
203 <when value="history"> 203 <when value="history">
204 <param name="genome_fasta" type="data" format="fasta" label="Genome Reference Fasta"/> 204 <param name="genome_fasta" type="data" format="fasta" label="Genome Reference Fasta"/>
205 <expand macro="ref_filtering_select" /> 205 <expand macro="ref_filtering_select" />
206 <expand macro="fasta_output_select" /> 206 <expand macro="fasta_output_select" />
207 </when> 207 </when>
208 </conditional> 208 </conditional>
209 209
210 <!-- outputs --> 210 <!-- outputs -->
211 <conditional name="gffs"> 211 <conditional name="gffs">
212 <param name="gff_fmt" type="select" optional="true" label="Feature File Output" help="(-o output.gff3|output.gtf)"> 212 <param name="gff_fmt" type="select" label="Feature File Output" help="(-o output.gff3|output.gtf)">
213 <option value="none">none</option> 213 <option value="none">none</option>
214 <option value="gff">GFF</option> 214 <option value="gff">GFF</option>
215 <option value="gtf">GTF</option> 215 <option value="gtf">GTF</option>
216 </param> 216 </param>
217 <when value="none"> 217 <when value="none">
225 <param name="output_cmd" type="hidden" value="-T -o output.gtf"/> 225 <param name="output_cmd" type="hidden" value="-T -o output.gtf"/>
226 <expand macro="trackname" /> 226 <expand macro="trackname" />
227 </when> 227 </when>
228 </conditional> 228 </conditional>
229 229
230 <param name="full_gff_attribute_preservation" type="boolean" truevalue="-F" falsevalue="" check="false" 230 <param name="full_gff_attribute_preservation" type="boolean" truevalue="-F" falsevalue="" check="false"
231 label="full GFF attribute preservation (all attributes are shown)" help="(-F)"/> 231 label="full GFF attribute preservation (all attributes are shown)" help="(-F)"/>
232 <param name="decode_url" type="boolean" truevalue="-D" falsevalue="" check="false" 232 <param name="decode_url" type="boolean" truevalue="-D" falsevalue="" check="false"
233 label="decode url encoded characters within attributes" help="(-D)"/> 233 label="decode url encoded characters within attributes" help="(-D)"/>
234 <param name="expose" type="boolean" truevalue="-E" falsevalue="" check="false" 234 <param name="expose" type="boolean" truevalue="-E" falsevalue="" check="false"
235 label="warn about duplicate transcript IDs and other potential problems with the given GFF/GTF records" help="(-E)"/> 235 label="warn about duplicate transcript IDs and other potential problems with the given GFF/GTF records" help="(-E)"/>
236 236
237 </inputs> 237 </inputs>
238 <outputs> 238 <outputs>
239 <data name="output_gff" format="gff3" metadata_source="input" label="${tool.name} on ${on_string}: gff3" from_work_dir="output.gff3"> 239 <data name="output_gff" format="gff3" metadata_source="input" label="${tool.name} on ${on_string}: gff3" from_work_dir="output.gff3">
357 357
358 .. _cufflinks: http://cole-trapnell-lab.github.io/cufflinks/ 358 .. _cufflinks: http://cole-trapnell-lab.github.io/cufflinks/
359 359
360 Usage: :: 360 Usage: ::
361 361
362 gffread "input_gff" [-g "genomic_seqs_fasta" | "dir"][-s "seq_info.fsize"] 362 gffread "input_gff" [-g "genomic_seqs_fasta" | "dir"][-s "seq_info.fsize"]
363 [-o "outfile.gff"] [-t "tname"] [-r [["strand"]"chr":]"start".."end" [-R]] 363 [-o "outfile.gff"] [-t "tname"] [-r [["strand"]"chr":]"start".."end" [-R]]
364 [-CTVNJMKQAFGUBHZWTOLE] [-w "exons.fa"] [-x "cds.fa"] [-y "tr_cds.fa"] 364 [-CTVNJMKQAFGUBHZWTOLE] [-w "exons.fa"] [-x "cds.fa"] [-y "tr_cds.fa"]
365 [-i "maxintron"] 365 [-i "maxintron"]
366 366
367 Options: :: 367 Options: ::
368 368
369 -g full path to a multi-fasta file with the genomic sequences 369 -g full path to a multi-fasta file with the genomic sequences
370 for all input mappings, OR a directory with single-fasta files 370 for all input mappings, OR a directory with single-fasta files
371 (one per genomic sequence, with file names matching sequence names) 371 (one per genomic sequence, with file names matching sequence names)
374 <seq-name> <seq-length> <seq-description> 374 <seq-name> <seq-length> <seq-description>
375 (useful for -A option with mRNA/EST/protein mappings) 375 (useful for -A option with mRNA/EST/protein mappings)
376 -i discard transcripts having an intron larger than <maxintron> 376 -i discard transcripts having an intron larger than <maxintron>
377 -r only show transcripts overlapping coordinate range <start>..<end> 377 -r only show transcripts overlapping coordinate range <start>..<end>
378 (on chromosome/contig <chr>, strand <strand> if provided) 378 (on chromosome/contig <chr>, strand <strand> if provided)
379 -R for -r option, discard all transcripts that are not fully 379 -R for -r option, discard all transcripts that are not fully
380 contained within the given range 380 contained within the given range
381 -U discard single-exon transcripts 381 -U discard single-exon transcripts
382 -C coding only: discard mRNAs that have no CDS feature 382 -C coding only: discard mRNAs that have no CDS feature
383 -F full GFF attribute preservation (all attributes are shown) 383 -F full GFF attribute preservation (all attributes are shown)
384 -G only parse additional exon attributes from the first exon 384 -G only parse additional exon attributes from the first exon
385 and move them to the mRNA level (useful for GTF input) 385 and move them to the mRNA level (useful for GTF input)
386 -A use the description field from <seq_info.fsize> and add it 386 -A use the description field from <seq_info.fsize> and add it
387 as the value for a 'descr' attribute to the GFF record 387 as the value for a 'descr' attribute to the GFF record
388 388
389 -O process also non-transcript GFF records (by default non-transcript 389 -O process also non-transcript GFF records (by default non-transcript
390 records are ignored) 390 records are ignored)
391 -V discard any mRNAs with CDS having in-frame stop codons 391 -V discard any mRNAs with CDS having in-frame stop codons
392 -H for -V option, check and adjust the starting CDS phase 392 -H for -V option, check and adjust the starting CDS phase
393 if the original phase leads to a translation with an 393 if the original phase leads to a translation with an
394 in-frame stop codon 394 in-frame stop codon
395 -B for -V option, single-exon transcripts are also checked on the 395 -B for -V option, single-exon transcripts are also checked on the
396 opposite strand 396 opposite strand
397 -N discard multi-exon mRNAs that have any intron with a non-canonical 397 -N discard multi-exon mRNAs that have any intron with a non-canonical
398 splice site consensus (i.e. not GT-AG, GC-AG or AT-AC) 398 splice site consensus (i.e. not GT-AG, GC-AG or AT-AC)
399 -J discard any mRNAs that either lack initial START codon 399 -J discard any mRNAs that either lack initial START codon
400 or the terminal STOP codon, or have an in-frame stop codon 400 or the terminal STOP codon, or have an in-frame stop codon
401 (only print mRNAs with a fulll, valid CDS) 401 (only print mRNAs with a fulll, valid CDS)
402 --no-pseudo: filter out records matching the 'pseudo' keyword 402 --no-pseudo: filter out records matching the 'pseudo' keyword
403 403
404 -M/--merge : cluster the input transcripts into loci, collapsing matching 404 -M/--merge : cluster the input transcripts into loci, collapsing matching
405 transcripts (those with the same exact introns and fully contained) 405 transcripts (those with the same exact introns and fully contained)
406 -d <dupinfo> : for -M option, write collapsing info to file <dupinfo> 406 -d <dupinfo> : for -M option, write collapsing info to file <dupinfo>
407 --cluster-only: same as --merge but without collapsing matching transcripts 407 --cluster-only: same as --merge but without collapsing matching transcripts
408 -K for -M option: also collapse shorter, fully contained transcripts 408 -K for -M option: also collapse shorter, fully contained transcripts
409 with fewer introns than the container 409 with fewer introns than the container
410 -Q for -M option, remove the containment restriction: 410 -Q for -M option, remove the containment restriction:
411 (multi-exon transcripts will be collapsed if just their introns match, 411 (multi-exon transcripts will be collapsed if just their introns match,
412 while single-exon transcripts can partially overlap (80%)) 412 while single-exon transcripts can partially overlap (80%))
413 413
414 --force-exons: make sure that the lowest level GFF features are printed as 414 --force-exons: make sure that the lowest level GFF features are printed as
415 "exon" features 415 "exon" features
416 -E expose (warn about) duplicate transcript IDs and other potential 416 -E expose (warn about) duplicate transcript IDs and other potential
417 problems with the given GFF/GTF records 417 problems with the given GFF/GTF records
418 -D decode url encoded characters within attributes 418 -D decode url encoded characters within attributes
419 -Z merge close exons into a single exon (for intron size<4) 419 -Z merge close exons into a single exon (for intron size<4)
420 -w write a fasta file with spliced exons for each GFF transcript 420 -w write a fasta file with spliced exons for each GFF transcript
421 -x write a fasta file with spliced CDS for each GFF transcript 421 -x write a fasta file with spliced CDS for each GFF transcript