annotate methylation_analysis/differential_methylation.xml @ 5:23fed0cf09f4 draft

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