annotate diffbind.xml @ 0:c0f5b2133506 draft default tip

initial commit for DiffBind
author bjoern-gruening
date Tue, 14 Jan 2014 18:12:02 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
1 <tool id="diffbind" name="DiffBind" version="2.0.1">
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
2 <description> differential binding analysis of ChIP-Seq peak data</description>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
3 <requirements>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
4 <requirement type="binary">Rscript</requirement>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
5 <requirement type="R-module">DESeq2</requirement>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
6 <requirement type="package" version="3.0.1">R_3_0_1</requirement>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
7 <requirement type="package" version="1.0.17">deseq2</requirement>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
8 <requirement type="package" version="1.8.3">diffbind</requirement>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
9 </requirements>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
10 <command interpreter="Rscript">
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
11 diffbind.R
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
12 -i $infile
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
13 -o $outfile
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
14 -p $plots
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
15 -f $format
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
16 ;
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
17 cat $infile;
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
18 </command>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
19 <stdio>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
20 <regex match="Execution halted"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
21 source="both"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
22 level="fatal"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
23 description="Execution halted." />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
24 <regex match="Input-Error 01"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
25 source="both"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
26 level="fatal"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
27 description="Error in your input parameters: Make sure you only apply factors to selected samples." />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
28 <regex match="Error in"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
29 source="both"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
30 level="fatal"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
31 description="An undefined error occured, please check your intput carefully and contact your administrator." />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
32 </stdio>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
33 <inputs>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
34 <repeat name="samples" title="Samples" min="2">
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
35 <param name="sample_id" type="text" value="Sample ID" label="Specify a sample id" help="e.g. BT474.1-" />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
36 <param name="tissue" type="text" value="Tissue" label="Specify the tissue" help="e.g. BT474" />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
37 <param name="factor" type="text" value="Factor Name" label="Specify a factor name" help="e.g. ER" />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
38 <param name="condition" type="text" value="Condition" label="Specify the condition" help="e.g. Resistent" />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
39 <param name="replicate" type="integer" value="1" label="Specify the replicate number" help="e.g. 1" />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
40 <param format="bam" name="bamreads" type="data" label="Read BAM file" help="Specify the Read BAM file, used for Peak calling."/>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
41 <param format="bam" name="bamcontrol" type="data" label="Control BAM file" help="Specify the Control BAM file, used for Peak calling."/>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
42 <param format="bed" name="peaks" type="data" label="Peak file" help="Result of your Peak calling experiment."/>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
43 </repeat>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
44 <param name="pdf" type="boolean" truevalue="" falsevalue="" checked="true"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
45 label="Visualising the analysis results"
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
46 help="output an additional PDF files" />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
47 <param name="format" type="select" label="Output Format">
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
48 <option value="bed">BED</option>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
49 <option value="gff">GFF</option>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
50 <option value="wig">WIG</option>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
51 </param>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
52 </inputs>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
53 <configfiles>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
54 <configfile name="infile">
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
55 SampleID,Tissue,Factor,Condition,Replicate,bamReads,bamControl,Peaks
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
56 #for $sample in $samples:
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
57 $sample.sample_id,$sample.tissue,$sample.factor,$sample.condition,$sample.replicate,$sample.bamreads,$sample.bamcontrol,$sample.peaks
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
58 #end for
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
59 </configfile>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
60 </configfiles>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
61 <outputs>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
62 <data format="bed" name="outfile" label="Differential binding sites on ${on_string}">
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
63 <change_format>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
64 <when input="format" value="wig" format="wig" />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
65 <when input="format" value="gff" format="gff" />
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
66 </change_format>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
67 </data>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
68 <data format="pdf" name="plots" label="Differential binding sites on ${on_string}">
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
69 <filter>pdf == True</filter>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
70 </data>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
71 </outputs>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
72
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
73 <help>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
74
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
75 .. class:: infomark
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
76
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
77 **What it does**
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
78
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
79
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
80 ------
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
81
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
82 **References**
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
83
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
84 DiffBind_ Authors: Rory Stark, Gordon Brown
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
85
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
86 .. _DiffBind: http://www.bioconductor.org/packages/release/bioc/html/DiffBind.html
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
87
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
88 Wrapper authors: Bjoern Gruening, Pavankumar Videm
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
89
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
90 </help>
c0f5b2133506 initial commit for DiffBind
bjoern-gruening
parents:
diff changeset
91 </tool>