Mercurial > repos > kpbioteam > chipeakanno_annopeaks

annotate chipeakanno_annopeaks.xml @ 1:a90b6d85463c draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b7298370ebae64340e792262c4e4f35568757871-dirty
author kpbioteam
date Wed, 02 May 2018 10:23:51 -0400
parents efd9e1315ed5
children ad60ed89de63
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
1 <tool id="chipeakanno_annopeaks" name="chipeakanno_annopeaks" version="0.1.0">
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
2 <description>annotate peaks by annoGR object in the given range</description>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
3 <requirements>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
4 <requirement type="package" version="3.12.0">bioconductor-chippeakanno</requirement>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
5 <requirement type="package" version="2.99.0">bioconductor-ensdb.hsapiens.v75</requirement>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
6 <requirement type="package" version="1.38.3">bioconductor-rtracklayer</requirement>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
7 </requirements>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
9 Rscript ${__tool_directory__}/chipeakanno_annopeaks.R "$input1" "$input2" "$input3" "$input4" "$output1"
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
10 ]]></command>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
11 <inputs>
1
a90b6d85463c planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b7298370ebae64340e792262c4e4f35568757871-dirty
kpbioteam
parents: 0
diff changeset
12 <param type="data" name="input1" format="bed"/>
0
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
13 <param name="input2" type="select" label="bindingType" help="Specifying the criteria to associate peaks with annotation e.g. startSite start position of the feature strand">
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
14 <option value="startSite">startSite</option>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
15 <option value="endSite">endSite</option>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
16 <option value="fullRange">fullRange</option>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
17 <option value="nearestBiDirectionalPromoters">nearestBiDirectionalPromoters</option>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
18 </param>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
19 <param name="input3" 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)"/>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
20 <param name="input4" 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)"/>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
21 </inputs>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
22 <outputs>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
23 <data name="output1" format="txt" />
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
24 </outputs>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
25 <tests>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
26 <test>
1
a90b6d85463c planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b7298370ebae64340e792262c4e4f35568757871-dirty
kpbioteam
parents: 0
diff changeset
27 <param name="input1" value="dmr.bed"/>
0
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
28 <param name="input2" value="startSite"/>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
29 <param name="input3" value="-5000"/>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
30 <param name="input4" value="5000"/>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
31 <output name="output1" file="annoTab.txt"/>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
32 </test>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
33 </tests>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
34 <help><![CDATA[
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
35 This tool annotate peaks from GRSet class.
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
36 bindingType
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
37 Specifying the criteria to associate peaks with annotation. Here is how to use it together with the parameter bindingRegion
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
38 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)
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
39 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)
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
40 To obtain peaks from 5kb upstream to 3kb downstream of genes/Exons , set bindingType = "fullRange" and bindingRegion = c(-5000, 3000)
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
41 To obtain peaks with nearest bi-directional promoters within 5kb upstream and 3kb downstream of TSS, set bindingType = "nearestBiDirectionalPromoters" and bindingRegion = c(-5000, 3000)
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
42 startSite
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
43 start position of the feature (strand is considered)
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
44 endSite
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
45 end position of the feature (strand is considered)
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
46 fullRange
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
47 whole range of the feature
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
48 nearestBiDirectionalPromoters
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
49 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.
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
50 bindingRegion
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
51 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.
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
52 ignore.peak.strand
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
53 ignore the peaks strand or not.
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
54 ]]></help>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
55 <citations>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
56 <citation type="doi">10.18129/B9.bioc.ChIPpeakAnno</citation>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
57 </citations>
efd9e1315ed5 planemo upload for repository https://github.com/kpbioteam/chipeakanno_annopeaks commit b81bbf4662bc9f8a936ccdf5813c3cd8020c579d-dirty
kpbioteam
parents:
diff changeset
58 </tool>