annotate gffcompare_to_bed.xml @ 2:9a4cfc910674 draft

"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 2a470e2c775a7427aa530e058510e4dc7b6d8e80"
author galaxyp
date Tue, 07 Apr 2020 11:36:42 -0400
parents 0f62097d7c1a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
9a4cfc910674 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 2a470e2c775a7427aa530e058510e4dc7b6d8e80"
galaxyp
parents: 1
diff changeset
1 <tool id="gffcompare_to_bed" name="Convert gffCompare annotated GTF to BED" version="0.2.1">
0
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
2 <description>for StringTie results</description>
2
9a4cfc910674 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 2a470e2c775a7427aa530e058510e4dc7b6d8e80"
galaxyp
parents: 1
diff changeset
3 <requirements>
9a4cfc910674 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 2a470e2c775a7427aa530e058510e4dc7b6d8e80"
galaxyp
parents: 1
diff changeset
4 <requirement type="package" version="3.7">python</requirement>
9a4cfc910674 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 2a470e2c775a7427aa530e058510e4dc7b6d8e80"
galaxyp
parents: 1
diff changeset
5 </requirements>
0
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
7 python '$__tool_directory__/gffcompare_to_bed.py'
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
8 #if $class_codes:
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
9 --class_code='$class_codes'
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
10 #end if
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
11 $input $output
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
12 ]]></command>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
13 <inputs>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
14 <param name="input" type="data" format="gtf" label="GTF annotated by gffCompare"/>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
15 <param name="class_codes" type="select" display="checkboxes" multiple="true" optional="true"
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
16 label="filter gffCompare class_codes to convert" help="No selection implies no filtering">
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
17 <option value="=">= : Complete match of intron chain</option>
1
0f62097d7c1a planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit e5ab6444aa2f104eedfa366bee05f65edef02d82
galaxyp
parents: 0
diff changeset
18 <option value="~">~ : Intron chain match or single-exon (gffcompare strict-match)</option>
0
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
19 <option value="c">c : Contained</option>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
20 <option value="j">j : Potentially novel isoform (fragment): at least one splice junction is shared with a reference transcript</option>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
21 <option value="e">e : Single exon transfrag overlapping a reference exon and at least 10 bp of a reference intron, indicating a possible pre-mRNA fragment.</option>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
22 <option value="i">i : A transfrag falling entirely within a reference intron</option>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
23 <option value="o">o : Generic exonic overlap with a reference transcript</option>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
24 <option value="p">p : Possible polymerase run-on fragment (within 2Kbases of a reference transcript)</option>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
25 <option value="r">r : Repeat. Currently determined by looking at the soft-masked reference sequence and applied to transcripts where at least 50% of the bases are lower case</option>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
26 <option value="u">u : Unknown, intergenic transcript</option>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
27 <option value="x">x : Exonic overlap with reference on the opposite strand</option>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
28 <option value="s">s : An intron of the transfrag overlaps a reference intron on the opposite strand (likely due to read mapping errors)</option>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
29 </param>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
30 </inputs>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
31 <outputs>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
32 <data name="output" format="bed" />
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
33 </outputs>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
34 <tests>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
35 <test>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
36 <param name="input" value="gffcompare_annotated.gtf" ftype="gtf"/>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
37 <output name="output" file="gffcompare_output.bed"/>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
38 </test>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
39 <test>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
40 <param name="input" value="gffcompare_annotated.gtf" ftype="gtf"/>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
41 <param name="class_codes" value="j"/>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
42 <output name="output" file="gffcompare_output_j.bed"/>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
43 </test>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
44 <test>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
45 <param name="input" value="gffcompare_annotated.gtf" ftype="gtf"/>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
46 <param name="class_codes" value="j,e,i,p,u,x"/>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
47 <output name="output" file="gffcompare_output_jeipux.bed"/>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
48 </test>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
49
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
50 </tests>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
51 <help><![CDATA[
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
52 Convert a GFFCompare annotated GTF file to BED format.
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
53
1
0f62097d7c1a planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit e5ab6444aa2f104eedfa366bee05f65edef02d82
galaxyp
parents: 0
diff changeset
54 A typical workflow:
0f62097d7c1a planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit e5ab6444aa2f104eedfa366bee05f65edef02d82
galaxyp
parents: 0
diff changeset
55
0f62097d7c1a planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit e5ab6444aa2f104eedfa366bee05f65edef02d82
galaxyp
parents: 0
diff changeset
56 .. image:: GTF2Bed_workflow.png
0f62097d7c1a planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit e5ab6444aa2f104eedfa366bee05f65edef02d82
galaxyp
parents: 0
diff changeset
57 :height: 308
0f62097d7c1a planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit e5ab6444aa2f104eedfa366bee05f65edef02d82
galaxyp
parents: 0
diff changeset
58 :width: 750
0f62097d7c1a planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit e5ab6444aa2f104eedfa366bee05f65edef02d82
galaxyp
parents: 0
diff changeset
59
0
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
60 usage: gffcompare_to_bed.py [-h] [-C CLASS_CODE] [-v] [-d] input output
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
61
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
62 positional arguments:
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
63 input GFFCompare annotated GTF file, (-) for stdin
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
64 output BED file, (-) for stdout
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
65
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
66 optional arguments:
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
67 -h, --help show this help message and exit
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
68 -C CLASS_CODE, --class_code CLASS_CODE
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
69 Restrict output to gffcompare class codes
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
70 -d, --debug Debug
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
71
1
0f62097d7c1a planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit e5ab6444aa2f104eedfa366bee05f65edef02d82
galaxyp
parents: 0
diff changeset
72 For class_code definitions see gffcompare documentation:
0f62097d7c1a planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit e5ab6444aa2f104eedfa366bee05f65edef02d82
galaxyp
parents: 0
diff changeset
73 http://ccb.jhu.edu/software/stringtie/gffcompare.shtml#transfrag-class-codes
0f62097d7c1a planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit e5ab6444aa2f104eedfa366bee05f65edef02d82
galaxyp
parents: 0
diff changeset
74
0
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
75 ]]></help>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
76 <citations>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
77 <citation type="doi">10.1038/nbt.1621</citation>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
78 </citations>
7e572e148175 planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/gffcompare_to_bed commit 321b217382f6be33bd77c7dbb51c8caf5fa50afe
galaxyp
parents:
diff changeset
79 </tool>