annotate methylation_analysis_bismark/methylation_analysis/differential_methylation.xml @ 9:5b208d4d89e5 draft

Uploaded
author fcaramia
date Tue, 04 Dec 2012 20:15:26 -0500
parents d15b4a2e3bdc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
1 <tool id="differential_methylation_tool" name="Differential Methylation" version="1.0.0">
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
2 <description>methylation status of two samples by region</description>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
3 <requirements>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
4 <requirement type="package" version="0.1.16">samtools</requirement>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
5 <requirement type="package" version="0.12.7">bowtie2</requirement>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
6 <requirement type="package" >getopt</requirement>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
7 <requirement type="package" >snow</requirement>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
8 <requirement type="package" >abind</requirement>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
9 <requirement type="package" >rtracklayer</requirement>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
10 <requirement type="package" >biomaRt</requirement>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
11
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
12 </requirements>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
13 <command >
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
14
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
15 differential_methylation.R -s $seg1 -t $seg2 -r $genome.fields.dbkey -p 1 -f $fdr -a $annot -o $output 2>1
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
16
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
17 </command>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
18 <inputs>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
19
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
20 <param name="seg1" type="data" format="tabular" label="Seg file 1" />
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
21 <param name="seg2" type="data" format="tabular" label="Seg file 2" />
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
22
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
23 <param name="genome" type="select" label="Select a reference genome" help="If your genome of interest is not listed, contact the Galaxy team">
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
24 <options from_data_table="bismark_indexes">
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
25 <filter type="sort_by" column="2"/>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
26 <validator type="no_options" message="No indexes are available for the selected input dataset"/>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
27 </options>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
28 </param>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
29 <param name="annot" type="select" label="Annotation">
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
30 <option value="both" selected="true">both</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
31 <option value="gene">gene</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
32 <option value="cpg">cpg</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
33 </param>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
34 <param name="fdr" type="select" label="fdr method">
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
35 <option value="none" selected="true">none</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
36 <option value="holm">holm</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
37 <option value="hochberg">hochberg</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
38 <option value="hommel">hommel</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
39 <option value="bonferroni">bonferroni</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
40 <option value="BH">BH</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
41 <option value="BY">BY</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
42 <option value="fdr">fdr</option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
43 </param>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
44
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
45
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
46
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
47 </inputs>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
48 <outputs>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
49 <data format="tabular" name="output" label="${tool.name} on ${on_string}">
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
50 <actions>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
51 <action type="metadata" name="dbkey">
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
52 <option type="from_data_table" name="bismark_indexes" column="1" offset="0">
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
53 <filter type="param_value" column="0" value="#" compare="startswith" keep="False"/>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
54 <filter type="param_value" ref="genome" column="0"/>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
55 </option>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
56 </action>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
57 </actions>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
58 </data>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
59
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
60 </outputs>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
61 <help>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
62 |
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
63
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
64 **What it does**
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
65
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
66 Compares the methylation status of two samples by region. It calculates a p.value for differential methylation using a test of proportions, that is, it tests the null hypothesis that the 2 methylation proportions are equal. The script will also calculate the difference in methylation and annotate the regions with the closest ensembl gene and cpg island. This script takes as input two seg files created by the tool "methylation_by_region_converter" and returns a new seg file containing:
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
67
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
68 ::
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
69
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
70 Comparison the name of the comparison
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
71 Chrom the chromosome of the region
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
72 loc.start the start of the region
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
73 loc.end the end of the region
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
74 Sample1.Methylated the number of methylated reads in the region for sample 1
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
75 Sample1.Total the total number of reads in the region for sample 1
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
76 Sample1.Proportion the proportion of methylated reads for sample 1
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
77 Sample2.Methylated the number of methylated reads in the region for sample 2
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
78 Sample2.Total the total number of reads in the region for sample 2
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
79 Sample2.Proportion the proportion of methylated reads for sample 2
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
80 X_Squared the test statistic for the test of proportions
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
81 P.value the raw p-value
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
82 P.adjusted the fdr adjusted p-value
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
83 ensembl_gene_id the closest or overlapping Ensembl gene id
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
84 hgnc_symbol the HUGO Gene Nomenclature Committee id
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
85 refseq_mrna the refseq id
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
86 feature_start the start of the gene
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
87 feature_end the end of the gene
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
88 Distance_To_Feature the distance to the feature
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
89 Cpg the closest or overlapping CpG island
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
90 cpg_perCpg the number of CpGs in island
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
91 cpg_perGc the percentage of island that is CpG
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
92 cpg_start the start location of the CpG island
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
93 cpg_end the end location of the CpG island
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
94 Distance_To_cpg the distance to the CpG island
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
95 DiffProp the difference in the methylation proportions
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
96
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
97 Usage: differential_methylation.R [[option][value]]
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
98 Options:
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
99 -h|--help view this help
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
100 -s|--segfile1 seg file 1
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
101 -t|--segfile2 seg file 2
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
102 -o|--output output file
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
103 -f|--fdr fdr method [holm|hochberg|hommel|bonferroni|BH|BY|fdr|none]
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
104 -r|--reference reference to use [hg19|GRCh37|mm9|NCBIM37|mm10|GRCm38|dm3|BDGP5]
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
105 -a|--annot annotation to add [both|gene|cpg]
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
106 -p|--processes number of cluster instances to open [1]
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
107
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
108
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
109
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
110 </help>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
111 </tool>
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
112
d15b4a2e3bdc Uploaded
fcaramia
parents:
diff changeset
113