annotate tools/filters/gtf2bedgraph.xml @ 2:c2a356708570

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:42 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="gtf2bedgraph" name="GTF-to-BEDGraph">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>converter</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">gtf_to_bedgraph_converter.py $input $out_file1 $attribute_name</command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 <param format="gtf" name="input" type="data" label="Convert this query"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 <param name="attribute_name" type="text" label="Attribute to Use for Value"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <data format="bedgraph" name="out_file1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <param name="input" value="gtf2bedgraph_in.gtf" ftype="gtf"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <param name="attribute_name" value="FPKM"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <output name="out_file1" file="gtf2bedgraph_out.bedgraph" ftype="bedgraph"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 This tool converts data from GTF format to BEDGraph format (scroll down for format description).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 --------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 **Example**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 The following data in GFF format::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 chr22 GeneA enhancer 10000000 10001000 500 + . gene_id "GeneA"; transcript_id "TranscriptAlpha"; FPKM "2.75"; frac "1.000000";
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 chr22 GeneA promoter 10010000 10010100 900 + . gene_id "GeneA"; transcript_id "TranscriptsAlpha"; FPKM "2.25"; frac "1.000000";
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 using the attribute name 'FPKM' will be converted to BEDGraph (**note** that 1 is subtracted from the start coordinate)::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 chr22 9999999 10001000 2.75
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 chr22 10009999 10010100 2.25
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 ------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 **About formats**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 **GTF format** Gene Transfer Format is a format for describing genes and other features associated with DNA, RNA and Protein sequences. GTF lines have nine tab-separated fields::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 1. seqname - Must be a chromosome or scaffold.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 2. source - The program that generated this feature.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 3. feature - The name of this type of feature. Some examples of standard feature types are "CDS", "start_codon", "stop_codon", and "exon".
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 4. start - The starting position of the feature in the sequence. The first base is numbered 1.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 5. end - The ending position of the feature (inclusive).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 6. score - A score between 0 and 1000. If there is no score value, enter ".".
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 7. strand - Valid entries include '+', '-', or '.' (for don't know/care).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 8. frame - If the feature is a coding exon, frame should be a number between 0-2 that represents the reading frame of the first base. If the feature is not a coding exon, the value should be '.'.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 9. group - The group field is a list of attributes. Each attribute consists of a type/value pair. Attributes must end in a semi-colon, and be separated from any following attribute by exactly one space. The attribute list must begin with the two mandatory attributes: (i) gene_id value - A globally unique identifier for the genomic source of the sequence and (ii) transcript_id value - A globally unique identifier for the predicted transcript.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 **BEDGraph format**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 The bedGraph format is line-oriented. Bedgraph data are preceeded by a track definition line, which adds a number of options for controlling the default display of this track.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 For the track definition line, all options are placed in a single line separated by spaces:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 track type=bedGraph name=track_label description=center_label
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 visibility=display_mode color=r,g,b altColor=r,g,b
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 priority=priority autoScale=on|off alwaysZero=on|off
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 gridDefault=on|off maxHeightPixels=max:default:min
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 graphType=bar|points viewLimits=lower:upper
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 yLineMark=real-value yLineOnOff=on|off
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 windowingFunction=maximum|mean|minimum smoothingWindow=off|2-16
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 The track type is REQUIRED, and must be bedGraph:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 type=bedGraph
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 Following the track definition line are the track data in four column BED format::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 chromA chromStartA chromEndA dataValueA
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 chromB chromStartB chromEndB dataValueB
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 </tool>