annotate pyCRAC/pyCalculateMutationFrequencies.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 ="pyCalculateMutationFrequencies" name="pyCalculateMutationFrequencies">
19b20927172d Uploaded
swebb
parents:
diff changeset
2 <requirements>
19b20927172d Uploaded
swebb
parents:
diff changeset
3 <requirement type="package">pyCRAC</requirement>
19b20927172d Uploaded
swebb
parents:
diff changeset
4 </requirements>
19b20927172d Uploaded
swebb
parents:
diff changeset
5 <command interpreter="python">
19b20927172d Uploaded
swebb
parents:
diff changeset
6 /usr/local/bin/pyCalculateMutationFrequencies.py
19b20927172d Uploaded
swebb
parents:
diff changeset
7 -r $readdatafile
19b20927172d Uploaded
swebb
parents:
diff changeset
8 -i $intervaldatafile
19b20927172d Uploaded
swebb
parents:
diff changeset
9 -c $addChr.chr
19b20927172d Uploaded
swebb
parents:
diff changeset
10 -o $output
19b20927172d Uploaded
swebb
parents:
diff changeset
11 --mutsfreq $mutsfreq
19b20927172d Uploaded
swebb
parents:
diff changeset
12 </command>
19b20927172d Uploaded
swebb
parents:
diff changeset
13 <version_command>/usr/local/bin/pyCalculateMutationFrequencies.py --version</version_command>
19b20927172d Uploaded
swebb
parents:
diff changeset
14 <inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
15 <param format="gff" name="readdatafile" type="data" label="GFF Reads File --readdatafile" help="GFF file containing read data" />
19b20927172d Uploaded
swebb
parents:
diff changeset
16 <param format="gtf" name="intervaldatafile" type="data" label="GFF Interval File --intervaldatafile" help="GFF file containing interval co-ordinates"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
17 <conditional name="addChr">
19b20927172d Uploaded
swebb
parents:
diff changeset
18 <param name="chrfile" type="select" label="Choose Chromosome length file from">
19b20927172d Uploaded
swebb
parents:
diff changeset
19 <option value="default" selected="true">Defaults</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
20 <option value="other">History</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
21 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
22 <when value="default">
19b20927172d Uploaded
swebb
parents:
diff changeset
23 <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
24 <options from_data_table="pycrac_chr"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
25 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
26 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
27 <when value="other">
19b20927172d Uploaded
swebb
parents:
diff changeset
28 <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
29 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
30 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
31
19b20927172d Uploaded
swebb
parents:
diff changeset
32 <param format="integer" name="mutsfreq" type="integer" label="Minimum mutation frequency --mutsfreq " value="0" size="10" help="sets the minimal mutations frequency for an interval that you want to have written to our output file">
19b20927172d Uploaded
swebb
parents:
diff changeset
33 <validator type="in_range" min="0" message="Please enter a value >= 0"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
34 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
35 <param name="label" type="text" format="txt" size="30" value="pyCalculateMutationFrequencies" label="Enter output file label -o" />
19b20927172d Uploaded
swebb
parents:
diff changeset
36 </inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
37 <outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
38 <data format="gtf" name="output" label="${label.value}.gtf"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
39 </outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
40 <help>
19b20927172d Uploaded
swebb
parents:
diff changeset
41
19b20927172d Uploaded
swebb
parents:
diff changeset
42 .. class:: infomark
19b20927172d Uploaded
swebb
parents:
diff changeset
43
19b20927172d Uploaded
swebb
parents:
diff changeset
44 **pyCalculateMutationFrequencies**
19b20927172d Uploaded
swebb
parents:
diff changeset
45
19b20927172d Uploaded
swebb
parents:
diff changeset
46 pyCalculateMutationFrequencies is part of the pyCRAC_ package. Takes an interval file and a pyReadCounters GTF file and calculates (cross-linking induced) mutation frequencies fore each interval.
19b20927172d Uploaded
swebb
parents:
diff changeset
47 This tool can be used to calculate mutation frequencies for significant intervals (pyCalculateFDRs output file) or over-represented motifs (pyMotif GTF output file).
19b20927172d Uploaded
swebb
parents:
diff changeset
48 It expects a pyCRAC GTF count_output_reads.gtf file and a GTF file with the intervals.
19b20927172d Uploaded
swebb
parents:
diff changeset
49
19b20927172d Uploaded
swebb
parents:
diff changeset
50 For example::
19b20927172d Uploaded
swebb
parents:
diff changeset
51
19b20927172d Uploaded
swebb
parents:
diff changeset
52 This pyCalculateFDRs GTF output file::
19b20927172d Uploaded
swebb
parents:
diff changeset
53
19b20927172d Uploaded
swebb
parents:
diff changeset
54 ##gff-version 2
19b20927172d Uploaded
swebb
parents:
diff changeset
55 # generated by pyCalculateFDRs version 0.0.3, Sat Jun 1 21:16:23 2013
19b20927172d Uploaded
swebb
parents:
diff changeset
56 # pyCalculateFDRs.py -f test_count_output_reads.gtf -r 200 -o test_count_output_FDRs_005.gtf -v -m 0.05
19b20927172d Uploaded
swebb
parents:
diff changeset
57 # chromosome feature source start end minimal_coverage strand . attributes
19b20927172d Uploaded
swebb
parents:
diff changeset
58 chrII protein_coding exon 203838 203887 3 + . gene_id "YBL011W"; gene_name "SCT1";
19b20927172d Uploaded
swebb
parents:
diff changeset
59 chrII intergenic_region exon 407669 407708 3 + . gene_id "INT_0_445"; gene_name "INT_0_445";
19b20927172d Uploaded
swebb
parents:
diff changeset
60 chrII intergenic_region exon 585158 585195 2 + . gene_id "INT_0_562"; gene_name "INT_0_562";
19b20927172d Uploaded
swebb
parents:
diff changeset
61 chrII protein_coding exon 372390 372433 4 - . gene_id "YBR067C"; gene_name "TIP1";
19b20927172d Uploaded
swebb
parents:
diff changeset
62 chrII intergenic_region exon 380754 380815 6 - . gene_id "INT_0_431"; gene_name "INT_0_431";
19b20927172d Uploaded
swebb
parents:
diff changeset
63 chrIII protein_coding exon 138001 138044 5 + . gene_id "YCR012W"; gene_name "PGK1";
19b20927172d Uploaded
swebb
parents:
diff changeset
64 chrIII intergenic_region exon 227997 228036 5 + . gene_id "INT_0_885"; gene_name "INT_0_885";
19b20927172d Uploaded
swebb
parents:
diff changeset
65 chrIII intergenic_region exon 227997 228037 4 + . gene_id "INT_0_887"; gene_name "INT_0_887";
19b20927172d Uploaded
swebb
parents:
diff changeset
66 chrIII tRNA exon 227997 228037 4 + . gene_id "tS(CGA)C"; gene_name "SUP61";
19b20927172d Uploaded
swebb
parents:
diff changeset
67
19b20927172d Uploaded
swebb
parents:
diff changeset
68 Will be converted into::
19b20927172d Uploaded
swebb
parents:
diff changeset
69
19b20927172d Uploaded
swebb
parents:
diff changeset
70 ##gff-version 2
19b20927172d Uploaded
swebb
parents:
diff changeset
71 # generated by pyCalculateFDRs version 0.0.3, Sat Jun 1 21:16:23 2013
19b20927172d Uploaded
swebb
parents:
diff changeset
72 # /Library/Frameworks/EPD64.framework/Versions/Current/bin/pyCalculateFDRs.py -f test_count_output_reads.gtf -r 200 -o test_count_output_FDRs_005.gtf -v -m 0.05
19b20927172d Uploaded
swebb
parents:
diff changeset
73 # chromosome feature source start end minimal_coverage strand . attributes
19b20927172d Uploaded
swebb
parents:
diff changeset
74 chrII protein_coding exon 203838 203887 3 + . gene_id "YBL011W"; gene_name "SCT1"; # 203882D33.3,203883D33.3,203884D33.3;
19b20927172d Uploaded
swebb
parents:
diff changeset
75 chrII intergenic_region exon 407669 407708 3 + . gene_id "INT_0_445"; gene_name "INT_0_445"; # 407680D33.3,407681D33.3;
19b20927172d Uploaded
swebb
parents:
diff changeset
76 chrII intergenic_region exon 585158 585195 2 + . gene_id "INT_0_562"; gene_name "INT_0_562"; # 585171D100.0,585172D100.0,585173D100.0;
19b20927172d Uploaded
swebb
parents:
diff changeset
77 chrII protein_coding exon 372390 372433 4 - . gene_id "YBR067C"; gene_name "TIP1"; # 372412D50.0,372413D50.0;
19b20927172d Uploaded
swebb
parents:
diff changeset
78 chrII intergenic_region exon 380754 380815 6 - . gene_id "INT_0_431"; gene_name "INT_0_431"; # 380786D90.2,380787D90.2;
19b20927172d Uploaded
swebb
parents:
diff changeset
79 chrIII protein_coding exon 138001 138044 5 + . gene_id "YCR012W"; gene_name "PGK1"; # 138025D40.0,138026D30.0,138027D40.0;
19b20927172d Uploaded
swebb
parents:
diff changeset
80 chrIII intergenic_region exon 227997 228036 5 + . gene_id "INT_0_885"; gene_name "INT_0_885"; # 228006D85.7,228007D100.0;
19b20927172d Uploaded
swebb
parents:
diff changeset
81 chrIII intergenic_region exon 227997 228037 4 + . gene_id "INT_0_887"; gene_name "INT_0_887"; # 228006D85.7,228007D100.0;
19b20927172d Uploaded
swebb
parents:
diff changeset
82 chrIII tRNA exon 227997 228037 4 + . gene_id "tS(CGA)C"; gene_name "SUP61"; # 228006D85.7,228007D100.0;
19b20927172d Uploaded
swebb
parents:
diff changeset
83
19b20927172d Uploaded
swebb
parents:
diff changeset
84
19b20927172d Uploaded
swebb
parents:
diff changeset
85 The hash character at the end of each line (#) shows chromosomal coordinates of mutated nucleotides within the cluster interval and their mutation frequencies.
19b20927172d Uploaded
swebb
parents:
diff changeset
86
19b20927172d Uploaded
swebb
parents:
diff changeset
87 For example::
19b20927172d Uploaded
swebb
parents:
diff changeset
88
19b20927172d Uploaded
swebb
parents:
diff changeset
89 # 228007D100.0
19b20927172d Uploaded
swebb
parents:
diff changeset
90
19b20927172d Uploaded
swebb
parents:
diff changeset
91 indicates that 100% of the nucleotides in position 228007 were deleted in the interval.
19b20927172d Uploaded
swebb
parents:
diff changeset
92
19b20927172d Uploaded
swebb
parents:
diff changeset
93 By setting the --mutsfreq flag you can set a limit for the lowest mutation frequency that you want to have reported.
19b20927172d Uploaded
swebb
parents:
diff changeset
94 This makes it relatively easy to select those significant regions that have nucleotides with high mutation frequencies.
19b20927172d Uploaded
swebb
parents:
diff changeset
95
19b20927172d Uploaded
swebb
parents:
diff changeset
96 .. _pyCRAC: http://sandergranneman.bio.ed.ac.uk/Granneman_Lab/pyCRAC_software.html
19b20927172d Uploaded
swebb
parents:
diff changeset
97
19b20927172d Uploaded
swebb
parents:
diff changeset
98 ------
19b20927172d Uploaded
swebb
parents:
diff changeset
99
19b20927172d Uploaded
swebb
parents:
diff changeset
100 **Parameter list**
19b20927172d Uploaded
swebb
parents:
diff changeset
101
19b20927172d Uploaded
swebb
parents:
diff changeset
102 Options::
19b20927172d Uploaded
swebb
parents:
diff changeset
103
19b20927172d Uploaded
swebb
parents:
diff changeset
104 -i intervals.gtf, --intervaldatafile=intervals.gtf
19b20927172d Uploaded
swebb
parents:
diff changeset
105 provide the path to your GTF interval data file.
19b20927172d Uploaded
swebb
parents:
diff changeset
106 -r reads.gtf, --readdatafile=reads.gtf
19b20927172d Uploaded
swebb
parents:
diff changeset
107 provide the path to your GTF read data file.
19b20927172d Uploaded
swebb
parents:
diff changeset
108 -c yeast.txt, --chromfile=yeast.txt
19b20927172d Uploaded
swebb
parents:
diff changeset
109 Location of the chromosome info file. This file should
19b20927172d Uploaded
swebb
parents:
diff changeset
110 have two columns: first column is the names of the
19b20927172d Uploaded
swebb
parents:
diff changeset
111 chromosomes, second column is length of the
19b20927172d Uploaded
swebb
parents:
diff changeset
112 chromosomes. Default is yeast
19b20927172d Uploaded
swebb
parents:
diff changeset
113 -o intervals_with_muts.gtf, --output_file=intervals_with_muts.gtf
19b20927172d Uploaded
swebb
parents:
diff changeset
114 provide a name for an output file. By default it
19b20927172d Uploaded
swebb
parents:
diff changeset
115 writes to the standard output
19b20927172d Uploaded
swebb
parents:
diff changeset
116 --mutsfreq=10, --mutationfrequency=10
19b20927172d Uploaded
swebb
parents:
diff changeset
117 sets the minimal mutations frequency for an interval
19b20927172d Uploaded
swebb
parents:
diff changeset
118 that you want to have written to our output file.
19b20927172d Uploaded
swebb
parents:
diff changeset
119 Default = 0%. Example: if the mutsfrequency is set at
19b20927172d Uploaded
swebb
parents:
diff changeset
120 10 and an interval position has a mutated in less than
19b20927172d Uploaded
swebb
parents:
diff changeset
121 10% of the reads,then the mutation will not be
19b20927172d Uploaded
swebb
parents:
diff changeset
122 reported.
19b20927172d Uploaded
swebb
parents:
diff changeset
123
19b20927172d Uploaded
swebb
parents:
diff changeset
124
19b20927172d Uploaded
swebb
parents:
diff changeset
125 </help>
19b20927172d Uploaded
swebb
parents:
diff changeset
126 </tool>