annotate diffbind.xml @ 1:9e9f85c20d99 draft

Uploaded
author bgruening
date Tue, 08 Sep 2015 05:38:45 -0400
parents 7faaf4a5e4e1
children 492d5ac7b2e2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
1 <tool id="diffbind" name="DiffBind" version="2.0.2">
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
2 <description> differential binding analysis of ChIP-Seq peak data</description>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
3 <requirements>
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
4 <requirement type="package" version="3.0.3">R</requirement>
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
5 <requirement type="package" version="1.2.10">deseq2</requirement>
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
6 <requirement type="package" version="1.8.3">diffbind</requirement>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
7 </requirements>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
8 <command>
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
9 <![CDATA[
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
10 ## seems that diffbind also needs file extensions to work properly
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
11 #set $counter = 1
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
12 #for $sample in $samples:
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
13 ln -s $sample.bamreads #echo str($counter) + "_bamreads.bam"# &&
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
14 ln -s ${sample.bamreads.metadata.bam_index} #echo str($counter) + "_bamreads.bai"# &&
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
15 ln -s $sample.bamcontrol #echo str($counter) + "_bamcontrol.bam"# &&
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
16 ln -s ${sample.bamcontrol.metadata.bam_index} #echo str($counter) + "_bamcontrol.bai"# &&
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
17 #set $counter = $counter + 1
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
18 #end for
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
19
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
20 Rscript $__tool_directory__/diffbind.R
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
21 -i $infile
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
22 -o $outfile
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
23 -p $plots
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
24 -f $format
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
25 ]]>
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
26 </command>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
27 <stdio>
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
28 <regex match="Execution halted"
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
29 source="both"
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
30 level="fatal"
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
31 description="Execution halted." />
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
32 <regex match="Input-Error 01"
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
33 source="both"
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
34 level="fatal"
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
35 description="Error in your input parameters: Make sure you only apply factors to selected samples." />
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
36 <regex match="Error in"
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
37 source="both"
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
38 level="fatal"
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
39 description="An undefined error occured, please check your intput carefully and contact your administrator." />
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
40 </stdio>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
41 <inputs>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
42 <repeat name="samples" title="Samples" min="2">
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
43 <param name="sample_id" type="text" value="Sample ID" label="Specify a sample id" help="e.g. BT474.1-" />
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
44 <param name="tissue" type="text" value="Tissue" label="Specify the tissue" help="e.g. BT474" />
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
45 <param name="factor" type="text" value="Factor Name" label="Specify a factor name" help="e.g. ER" />
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
46 <param name="condition" type="text" value="Condition" label="Specify the condition" help="e.g. Resistent" />
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
47 <param name="replicate" type="integer" value="1" label="Specify the replicate number" help="e.g. 1" />
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
48 <param format="bam" name="bamreads" type="data" label="Read BAM file" help="Specify the Read BAM file, used for Peak calling."/>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
49 <param format="bam" name="bamcontrol" type="data" label="Control BAM file" help="Specify the Control BAM file, used for Peak calling."/>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
50 <param format="bed" name="peaks" type="data" label="Peak file" help="Result of your Peak calling experiment."/>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
51 </repeat>
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
52 <param name="pdf" type="boolean" truevalue="" falsevalue="" checked="true"
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
53 label="Visualising the analysis results"
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
54 help="output an additional PDF files" />
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
55 <param name="format" type="select" label="Output Format">
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
56 <option value="bed">BED</option>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
57 <option value="gff">GFF</option>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
58 <option value="wig">WIG</option>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
59 </param>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
60 </inputs>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
61 <configfiles>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
62 <configfile name="infile">
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
63 SampleID,Tissue,Factor,Condition,Replicate,bamReads,bamControl,Peaks
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
64 #set $counter = 1
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
65 #for $sample in $samples:
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
66 $sample.sample_id,$sample.tissue,$sample.factor,$sample.condition,$sample.replicate,#echo str($counter) + '_bamreads.bam'#,#echo str($counter) + '_bamcontrol.bam'#,$sample.peaks
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
67 #set $counter = $counter + 1
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
68 #end for
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
69 </configfile>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
70 </configfiles>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
71 <outputs>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
72 <data format="bed" name="outfile" label="Differential binding sites on ${on_string}">
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
73 <change_format>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
74 <when input="format" value="wig" format="wig" />
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
75 <when input="format" value="gff" format="gff" />
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
76 </change_format>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
77 </data>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
78 <data format="pdf" name="plots" label="Differential binding sites on ${on_string}">
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
79 <filter>pdf == True</filter>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
80 </data>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
81 </outputs>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
82
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
83 <help>
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
84 <![CDATA[
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
85
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
86
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
87 **What it does**
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
88
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
89 Diffbind provides functions for processing ChIP-Seq data enriched for genomic loci where specific protein/DNA binding occurs, including peak sets identified by ChIP-Seq peak callers and aligned sequence read datasets.
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
90
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
91 **Input**
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
92
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
93 - You have to specify your samples. Here is one example:
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
94
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
95 ID Tissue Factor Condition Treatment Replicate Caller Intervals
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
96 BT4741 BT474 ER Resistant Full-Media 1 raw 1084
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
97
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
98 - BAM file which contains the mapped sequencing reads can be associated with each
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
99 peakset
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
100
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
101 - Control BAM file represents a control dataset
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
102
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
103 - Peak file: Result of your Peak calling experiment
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
104
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
105
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
106 **Output**
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
107
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
108 As output format you can choose BED, GFF, WIG.
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
109
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
110
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
111 **References**
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
112
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
113 DiffBind_ Authors: Rory Stark, Gordon Brown (2011)
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
114
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
115 .. _DiffBind: http://www.bioconductor.org/packages/release/bioc/html/DiffBind.html
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
116
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
117 Wrapper authors: Bjoern Gruening, Pavankumar Videm
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
118
1
9e9f85c20d99 Uploaded
bgruening
parents: 0
diff changeset
119 ]]>
0
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
120 </help>
7faaf4a5e4e1 Uploaded
bgruening
parents:
diff changeset
121 </tool>