annotate chipeakanno_annopeaks.xml @ 3:6f52c0dc56d4 draft

Uploaded
author kpbioteam
date Fri, 10 May 2019 06:45:34 -0400
parents 95ad07b229df
children 104882a2de00
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
1 <tool id="chipeakanno_annopeaks" name="ChIPpeakAnno annoPeaks" version="0.1.0">
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
2 <description>annotate peaks by annoGR object in the given range</description>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
3 <requirements>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
4 <requirement type="package" version="3.16.0-0">bioconductor-chippeakanno</requirement>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
5 <requirement type="package" version="2.99.0-3">bioconductor-ensdb.hsapiens.v75</requirement>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
6 <requirement type="package" version="1.42.1-1">bioconductor-rtracklayer</requirement>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
7 </requirements>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
9 Rscript '$chipeakanno_annopeaks_script'
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
10 ]]></command>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
11 <configfiles>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
12 <configfile name="chipeakanno_annopeaks_script"><![CDATA[
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
13 require("ChIPpeakAnno", quietly = TRUE)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
14 require("EnsDb.Hsapiens.v75", quietly = TRUE)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
15 require("rtracklayer", quietly = TRUE)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
16
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
17 options(warn = -1)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
18
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
19 data <- read.table('$dmp')
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
20
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
21 peaks <- GRanges(seqnames = data[, 1],
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
22 ranges = IRanges
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
23 (start = data[, 2], end = data[, 3]),score=data[, as.numeric('$score')])
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
24
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
25 db <- toGRanges(EnsDb.Hsapiens.v75)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
26 seqlevelsStyle(peaks) <- seqlevelsStyle(db)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
27
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
28 start <- as.numeric('$start')
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
29 end <- as.numeric('$end')
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
30
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
31 anno <- annoPeaks(peaks, annoData=db, bindingType =c('$type'), bindingRegion=c(start, end))
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
32
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
33 write.table(anno, file= '$tab', quote = FALSE, row.names = FALSE, sep = "\t")
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
34 ]]>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
35 </configfile>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
36 </configfiles>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
37 <inputs>
3
6f52c0dc56d4 Uploaded
kpbioteam
parents: 0
diff changeset
38 <param type="data" name="dmp" format="interval" label="Differentially Methylated Positions"/>
0
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
39 <param name="type" type="select" label="bindingType" help="Specifying the criteria to associate peaks with annotation e.g. startSite start position of the feature strand">
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
40 <option value="startSite">startSite</option>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
41 <option value="endSite">endSite</option>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
42 <option value="fullRange">fullRange</option>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
43 <option value="nearestBiDirectionalPromoters">nearestBiDirectionalPromoters</option>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
44 </param>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
45 <param name="start" type="text" value="-5000" label="bindingRegionStart" help="e.g. to obtain peaks within 5kb upstream and up to 3kb downstream of TSS within the gene body, set bindingType = startSite and bindingRegion = c(-5000, 3000)"/>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
46 <param name="end" type="text" value="3000" label="bindingRegionEnd" help="e.g. to obtain peaks with nearest bi-directional promoters within 5kb upstream and 3kb downstream of TSS, set bindingType = nearestBiDirectionalPromoters and bindingRegion = c(-5000, 3000)"/>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
47
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
48 <param name="score" type="text" value="5" label="Additional Column of Score" help="Position of Additional Column of the Score" />
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
49 </inputs>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
50 <outputs>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
51 <data name="tab" format="tabular" label="Table of Annotated Peaks"/>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
52 </outputs>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
53 <tests>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
54 <test>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
55 <param name="dmp" value="Differentially_Methylated_Regions.interval"/>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
56 <param name="type" value="startSite"/>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
57 <param name="start" value="-5000"/>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
58 <param name="end" value="5000"/>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
59 <param name="score" value="5"/>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
60 <output name="tab" file="annoTab.tabular"/>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
61 </test>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
62 </tests>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
63 <help><![CDATA[
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
64 This tool annotate peaks from bed file.
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
65 bindingType
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
66 Specifying the criteria to associate peaks with annotation. Here is how to use it together with the parameter bindingRegion
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
67 To obtain peaks within 5kb upstream and up to 3kb downstream of TSS within the gene body, set bindingType = "startSite" and bindingRegion = c(-5000, 3000)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
68 To obtain peaks up to 5kb upstream within the gene body and 3kb downstream of gene/Exon End, set bindingType = "endSite" and bindingRegion = c(-5000, 3000)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
69 To obtain peaks from 5kb upstream to 3kb downstream of genes/Exons , set bindingType = "fullRange" and bindingRegion = c(-5000, 3000)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
70 To obtain peaks with nearest bi-directional promoters within 5kb upstream and 3kb downstream of TSS, set bindingType = "nearestBiDirectionalPromoters" and bindingRegion = c(-5000, 3000)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
71 startSite
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
72 start position of the feature (strand is considered)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
73 endSite
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
74 end position of the feature (strand is considered)
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
75 fullRange
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
76 whole range of the feature
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
77 nearestBiDirectionalPromoters
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
78 nearest promoters from both direction of the peaks (strand is considered). It will report bidirectional promoters if there are promoters in both directions in the given region (defined by bindingRegion). Otherwise, it will report the closest promoter in one direction.
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
79 bindingRegion
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
80 Annotation range used together with bindingType, which is a vector with two integer values, default to c (-5000, 5000). The first one must be no bigger than 0. And the sec ond one must be no less than 1. For details, see bindingType.
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
81 ignore.peak.strand
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
82 ignore the peaks strand or not.
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
83 ]]></help>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
84 <citations>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
85 <citation type="doi">10.18129/B9.bioc.ChIPpeakAnno</citation>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
86 </citations>
95ad07b229df Uploaded
kpbioteam
parents:
diff changeset
87 </tool>