annotate pyCRAC/pyGTF2bedGraph.xml @ 1:7c9574213c0a draft default tip

Uploaded
author swebb
date Thu, 20 Jun 2013 12:13:43 -0400
parents 19b20927172d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
19b20927172d Uploaded
swebb
parents:
diff changeset
1 <tool id="pyGTF2bedGraph" name="pyGTF2bedGraph">
19b20927172d Uploaded
swebb
parents:
diff changeset
2 <description>converter</description>
19b20927172d Uploaded
swebb
parents:
diff changeset
3 <requirements>
19b20927172d Uploaded
swebb
parents:
diff changeset
4 <requirement type="package">pyCRAC</requirement>
19b20927172d Uploaded
swebb
parents:
diff changeset
5 </requirements>
19b20927172d Uploaded
swebb
parents:
diff changeset
6 <command interpreter="perl">pyGTF2bedGraph.pl --gtf $input --po $po --mo $mo
19b20927172d Uploaded
swebb
parents:
diff changeset
7 --chromfile $addchr.chr
19b20927172d Uploaded
swebb
parents:
diff changeset
8 -t $type
19b20927172d Uploaded
swebb
parents:
diff changeset
9 --count $count
19b20927172d Uploaded
swebb
parents:
diff changeset
10 $iclip
19b20927172d Uploaded
swebb
parents:
diff changeset
11 #if $addtrack.track == "--track":
19b20927172d Uploaded
swebb
parents:
diff changeset
12 --track
19b20927172d Uploaded
swebb
parents:
diff changeset
13 --name $addtrack.name
19b20927172d Uploaded
swebb
parents:
diff changeset
14 --description $addtrack.description
19b20927172d Uploaded
swebb
parents:
diff changeset
15 #if $addtrack.colorscheme.colorsel == "default":
19b20927172d Uploaded
swebb
parents:
diff changeset
16 --color $addtrack.colorscheme.color
19b20927172d Uploaded
swebb
parents:
diff changeset
17 #else:
19b20927172d Uploaded
swebb
parents:
diff changeset
18 -s '$addtrack.colorscheme.plus,$addtrack.colorscheme.minus'
19b20927172d Uploaded
swebb
parents:
diff changeset
19 #end if#
19b20927172d Uploaded
swebb
parents:
diff changeset
20 #end if#
19b20927172d Uploaded
swebb
parents:
diff changeset
21 --id $po.id
19b20927172d Uploaded
swebb
parents:
diff changeset
22 </command>
19b20927172d Uploaded
swebb
parents:
diff changeset
23 <version_command>/usr/local/bin/pyGTF2bedGraph.py --version</version_command>
19b20927172d Uploaded
swebb
parents:
diff changeset
24 <inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
25 <param name="input" type="data" format="gtf" label="GTF file --gtf"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
26 <conditional name="addchr">
19b20927172d Uploaded
swebb
parents:
diff changeset
27 <param name="chrfile" type="select" label="Choose Chromosome length file from">
19b20927172d Uploaded
swebb
parents:
diff changeset
28 <option value="default" selected="true">Defaults</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
29 <option value="other">History</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
30 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
31 <when value="default">
19b20927172d Uploaded
swebb
parents:
diff changeset
32 <param name="chr" type="select" label="Chromosome length file -c" help="This file should have two columns: first column is the names of the chromosomes, second column is length of the chromosomes. Use pyCrac utility pyCalculateChromosomeLengths to create.">
19b20927172d Uploaded
swebb
parents:
diff changeset
33 <options from_data_table="pycrac_chr"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
34 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
35 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
36 <when value="other">
19b20927172d Uploaded
swebb
parents:
diff changeset
37 <param format="tabular" name="chr" type="data" label="Chromosome length file -c" help="This file should have two columns: first column is the names of the chromosomes, second column is length of the chromosomes"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
38 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
39 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
40 <param name="type" type="select" label="Choose type of data -t">
19b20927172d Uploaded
swebb
parents:
diff changeset
41 <option value="reads" selected="true">Reads</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
42 <option value="substitutions">Substitutions</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
43 <option value="deletions">Deletions</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
44 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
45 <param format="integer" name="count" type="integer" label="Count per feature --count " value="1" size="5" help="Takes the numbers in the 'score' column of the GTF file as the total number of reads for each position" >
19b20927172d Uploaded
swebb
parents:
diff changeset
46 <validator type="in_range" min="1" message="Please enter a value >= 1"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
47 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
48 <param name="iclip" type="select" label="iCLIP mode --iCLIP">
19b20927172d Uploaded
swebb
parents:
diff changeset
49 <option value="" selected="true">OFF</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
50 <option value="--iCLIP">ON</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
51 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
52 <conditional name="addtrack">
19b20927172d Uploaded
swebb
parents:
diff changeset
53 <param name="track" type="select" label="Add UCSC track line to output">
19b20927172d Uploaded
swebb
parents:
diff changeset
54 <option value="" selected="true">NO</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
55 <option value="--track">YES</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
56 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
57 <when value=""/>
19b20927172d Uploaded
swebb
parents:
diff changeset
58 <when value="--track">
19b20927172d Uploaded
swebb
parents:
diff changeset
59 <param name="name" format="txt" type="text" value="User_supplied_track" size="80" label="Track name"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
60 <param name="description" format="txt" type="text" value="User_supplied_track" size="80" label="Track description"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
61 <conditional name="colorscheme">
19b20927172d Uploaded
swebb
parents:
diff changeset
62 <param name="colorsel" type="select" label="Colouring scheme">
19b20927172d Uploaded
swebb
parents:
diff changeset
63 <option value="default" selected="true">One Colour</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
64 <option value="strand">By Strand</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
65 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
66 <when value="default">
19b20927172d Uploaded
swebb
parents:
diff changeset
67 <param name="color" type="select" label="Choose track colour">
19b20927172d Uploaded
swebb
parents:
diff changeset
68 <option value="black" selected="true">Black</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
69 <option value="red">Red</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
70 <option value="blue">Blue</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
71 <option value="green">Green</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
72 <option value="purple">Purple</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
73 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
74 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
75 <when value="strand">
19b20927172d Uploaded
swebb
parents:
diff changeset
76 <param name="plus" type="select" label="Choose forward strand track colour">
19b20927172d Uploaded
swebb
parents:
diff changeset
77 <option value="black" selected="true">Black</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
78 <option value="red">Red</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
79 <option value="blue">Blue</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
80 <option value="green">Green</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
81 <option value="purple">Purple</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
82 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
83 <param name="minus" type="select" label="Choose minus strand track colour">
19b20927172d Uploaded
swebb
parents:
diff changeset
84 <option value="black" selected="true">Black</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
85 <option value="red">Red</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
86 <option value="blue">Blue</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
87 <option value="green">Green</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
88 <option value="purple">Purple</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
89 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
90 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
91 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
92 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
93 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
94 <param name="label" type="text" format="txt" size="30" value="pyGTF2bedGraph" label="Enter output file label -o" />
19b20927172d Uploaded
swebb
parents:
diff changeset
95 </inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
96 <outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
97 <data name="po" format="bedgraph" label="${label.value}_plus_strand.bg"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
98 <data name="mo" format="bedgraph" label="${label.value}_minus_strand.bg"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
99 </outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
100 <help>
19b20927172d Uploaded
swebb
parents:
diff changeset
101
19b20927172d Uploaded
swebb
parents:
diff changeset
102 .. class:: infomark
19b20927172d Uploaded
swebb
parents:
diff changeset
103
19b20927172d Uploaded
swebb
parents:
diff changeset
104 **pyGTF2bedGraph**
19b20927172d Uploaded
swebb
parents:
diff changeset
105
19b20927172d Uploaded
swebb
parents:
diff changeset
106 pyGTF2bedGraph is part of the pyCRAC_ package. Generates bedgraph files for each chromosome. An homage to bedtools genomecoverage. Takes a pyReadCounters GTF file as input file. Can also output bedGraph files for substitutions and deletions.
19b20927172d Uploaded
swebb
parents:
diff changeset
107
19b20927172d Uploaded
swebb
parents:
diff changeset
108 .. _pyCRAC: http://sandergranneman.bio.ed.ac.uk/Granneman_Lab/pyCRAC_software.html
19b20927172d Uploaded
swebb
parents:
diff changeset
109
19b20927172d Uploaded
swebb
parents:
diff changeset
110 ------
19b20927172d Uploaded
swebb
parents:
diff changeset
111
19b20927172d Uploaded
swebb
parents:
diff changeset
112 **Parameter list**
19b20927172d Uploaded
swebb
parents:
diff changeset
113
19b20927172d Uploaded
swebb
parents:
diff changeset
114 File input options::
19b20927172d Uploaded
swebb
parents:
diff changeset
115
19b20927172d Uploaded
swebb
parents:
diff changeset
116 --gtf=readdata.gtf
19b20927172d Uploaded
swebb
parents:
diff changeset
117 type the path to the gtf file data file. Be default it
19b20927172d Uploaded
swebb
parents:
diff changeset
118 expects data from the standard input
19b20927172d Uploaded
swebb
parents:
diff changeset
119 -o converted
19b20927172d Uploaded
swebb
parents:
diff changeset
120 provide a name for an output file. A file extension or
19b20927172d Uploaded
swebb
parents:
diff changeset
121 strand information is not necessary.
19b20927172d Uploaded
swebb
parents:
diff changeset
122 -c yeast.txt, --chromfile=yeast.txt
19b20927172d Uploaded
swebb
parents:
diff changeset
123 Location of the chromosome info file. This file should
19b20927172d Uploaded
swebb
parents:
diff changeset
124 have two columns: first column is the names of the
19b20927172d Uploaded
swebb
parents:
diff changeset
125 chromosomes, second column is length of the
19b20927172d Uploaded
swebb
parents:
diff changeset
126 chromosomes. Default is yeast
19b20927172d Uploaded
swebb
parents:
diff changeset
127 -t TYPE, --type=TYPE
19b20927172d Uploaded
swebb
parents:
diff changeset
128 this tool can generate bedGraph files for reads,
19b20927172d Uploaded
swebb
parents:
diff changeset
129 substitutions or deletions. Please use
19b20927172d Uploaded
swebb
parents:
diff changeset
130 'reads','substitutions' or 'deletions' to indicate the
19b20927172d Uploaded
swebb
parents:
diff changeset
131 type of data. Default='reads'
19b20927172d Uploaded
swebb
parents:
diff changeset
132 --count
19b20927172d Uploaded
swebb
parents:
diff changeset
133 Takes the numbers in the 'score' column of the GTF
19b20927172d Uploaded
swebb
parents:
diff changeset
134 file as the total number of reads for each position.
19b20927172d Uploaded
swebb
parents:
diff changeset
135 Default is 1 for each interval.
19b20927172d Uploaded
swebb
parents:
diff changeset
136 --iCLIP
19b20927172d Uploaded
swebb
parents:
diff changeset
137 This turns on the iCLIP mode and the sgr reads or cDNA
19b20927172d Uploaded
swebb
parents:
diff changeset
138 files will report cross-linking site frequencies in
19b20927172d Uploaded
swebb
parents:
diff changeset
139 iCLIP data
19b20927172d Uploaded
swebb
parents:
diff changeset
140 -v, --verbose
19b20927172d Uploaded
swebb
parents:
diff changeset
141 to print status messages to a log file
19b20927172d Uploaded
swebb
parents:
diff changeset
142
19b20927172d Uploaded
swebb
parents:
diff changeset
143 These options can be used to add a track line for the UCSC genome browser::
19b20927172d Uploaded
swebb
parents:
diff changeset
144
19b20927172d Uploaded
swebb
parents:
diff changeset
145 --track
19b20927172d Uploaded
swebb
parents:
diff changeset
146 Use this flag to add a UCSC genome browser track line
19b20927172d Uploaded
swebb
parents:
diff changeset
147 to the beginning of your file
19b20927172d Uploaded
swebb
parents:
diff changeset
148 -n NAME, --name=NAME
19b20927172d Uploaded
swebb
parents:
diff changeset
149 For the USCS track line: provide a track name. Default
19b20927172d Uploaded
swebb
parents:
diff changeset
150 = 'User_supplied_track'
19b20927172d Uploaded
swebb
parents:
diff changeset
151 -d DESCRIPTION, --description=DESCRIPTION
19b20927172d Uploaded
swebb
parents:
diff changeset
152 For the USCS track line: provide a track description.
19b20927172d Uploaded
swebb
parents:
diff changeset
153 Default = 'User_supplied_track'
19b20927172d Uploaded
swebb
parents:
diff changeset
154 --color=COLOR
19b20927172d Uploaded
swebb
parents:
diff changeset
155 select the track color. Default = black
19b20927172d Uploaded
swebb
parents:
diff changeset
156 -s STRANDS, --colorstrands=STRANDS
19b20927172d Uploaded
swebb
parents:
diff changeset
157 select the colors for each strand. Default =
19b20927172d Uploaded
swebb
parents:
diff changeset
158 'red,blue'
19b20927172d Uploaded
swebb
parents:
diff changeset
159
19b20927172d Uploaded
swebb
parents:
diff changeset
160 </help>
19b20927172d Uploaded
swebb
parents:
diff changeset
161 </tool>
19b20927172d Uploaded
swebb
parents:
diff changeset
162