annotate galaxy-conf/ReadLengthDistributionMatrix.xml @ 20:9d56b5b85740 draft

Reuploaded to see if tools get loaded correctly this time.
author timpalpant
date Fri, 15 Jun 2012 15:10:26 -0400
parents eb53be9a09f4
children b43c420a6135
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
1 <tool id="ReadLengthDistributionMatrix" name="Create read length distribution matrix" version="1.0.0">
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
2 <description>across a genomic interval</description>
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
3 <command interpreter="sh">galaxyToolRunner.sh ngs.ReadLengthDistributionMatrix -i $input --chr $chr --start $start --stop $stop --min $min --max $max --bin $bin -o $output</command>
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
4 <inputs>
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
5 <param format="sam,bam,bed,bedgraph" name="input" type="data" label="Mapped reads" />
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
6 <param name="chr" type="text" label="Chromosome" />
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
7 <param name="start" type="integer" value="1" label="Start base pair" />
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
8 <param name="stop" type="integer" value="1000" label="Stop base pair" />
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
9 <param name="min" type="integer" value="1" label="Minimum fragment length (bp)" />
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
10 <param name="max" type="integer" value="200" label="Maximum fragment length (bp)" />
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
11 <param name="bin" type="integer" value="1" label="Fragment length bin size (bp)" />
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
12 </inputs>
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
13 <outputs>
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
14 <data format="tabular" name="output" />
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
15 </outputs>
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
16
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
17 <help>
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
18
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
19 This tool will create a matrix (in matrix2png_ format) with the distribution of read lengths over each base pair. Reads are binned by genomic location and length to create a matrix where each column represents the distribution of read lengths over that base pair. The resulting matrix can be turned into heatmap using the Visualization -> Make heatmap with matrix2png tool.
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
20
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
21 .. _matrix2png: http://bioinformatics.ubc.ca/matrix2png/dataformat.html
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
22
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
23 .. class:: warningmark
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
24
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
25 This tool requires paired-end SAM, BAM, Bed, or BedGraph formatted data. Using single-end data will result in a constant read length.
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
26
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
27 -----
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
28
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
29 **Syntax**
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
30
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
31 - **Mapped reads** are the mapped paired-end reads used to make the histograms
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
32 - **Chromosome** a locus in the genome
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
33 - **Start base pair** a locus in the genome
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
34 - **Stop base pair** a locus in the genome
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
35 - **Minimum fragment length** is the lowest fragment length bin. Reads shorter than this will be ignored.
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
36 - **Maximum fragment length** is the highest fragment length bin. Reads longer than this will be ignored.
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
37 - **Fragment length bin size** is the bin size used when making the fragment length histograms
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
38
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
39 -----
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
40
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
41 **Example**
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
42
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
43 Make a matrix with the read length distribution across the region chrI:5001-6000, looking at reads 100-200bp in length in bins of 1bp:
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
44
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
45 - **Chromosome:** chrI
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
46 - **Start:** 5001
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
47 - **Stop:** 6000
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
48 - **Minimum fragment length:** 100
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
49 - **Maximum fragment length:** 200
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
50 - **Fragment length bin size:** 1
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
51
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
52 The resulting matrix will be 1000x101, with each column representing a base pair and each row representing a read length. The column headers give the base pair and the row headers give the read length.
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
53
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
54 -----
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
55
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
56 **Citation**
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
57
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
58 This tool was inspired by the analysis and figures in
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
59
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
60 Floer M, Wang X, Prabhu V, Berrozpe G, Narayan S, Spagna D, Alvarez D, Kendall J, Krasnitz A, Stepansky A, Hicks J, Bryant GO and Ptashne M (2010) A RSC/nucleosome complex determines chromatin architecture and facilitates activator binding. Cell 141: 407–418
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
61
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
62 </help>
eb53be9a09f4 Uploaded
timpalpant
parents:
diff changeset
63 </tool>