annotate baseline.xml @ 26:00278c5fe014

fixed typo
author Franco Caramia <franco.caramia@petermac.org>
date Tue, 03 Jun 2014 17:34:35 +1000
parents 2770f49cb0dc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
1 <tool id="baseline_tool" name="Baseline" version="1.0.0">
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
2 <description>: Control files for Contra</description>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
3 <requirements>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
4 <requirement type="package" version="2.17.0">bedtools</requirement>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
5 <requirement type="package" name="samtools" version="0.1.18">samtools</requirement>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
6 <requirement type="package" name="contra" version="2.0.4">contra</requirement>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
7 </requirements>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
8 <command interpreter="perl">
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
9
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
10 baseline_wrapper.pl
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
11
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
12 ##Required files
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
13 "PLAYEROPTION::-t=$target_file"
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
14
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
15 #for $group in $file_group
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
16 "BAMLISTENTRY::${group.bam}"
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
17 #end for
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
18
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
19 "PLAYEROPTION::--name=$sampleName"
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
20 "PLAYEROPTION::--trim=$trim"
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
21
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
22 ##File to generate the bam list
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
23 "BASELINEOUTPUT::$baseline_output"
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
24 </command>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
25 <inputs>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
26 <param name="target_file" type="data" format="bed" help="" optional="false" />
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
27 <repeat name="file_group" title="Bam file">
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
28 <param format="bam" name="bam" type="data" label="BAM File" help=""/>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
29 </repeat>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
30 <param name="sampleName" value="baseline" type="text" optional="true" />
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
31 <param name="trim" type="float" value="0.2" optional="true" />
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
32
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
33
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
34 </inputs>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
35 <outputs>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
36 <data name="baseline_output" title="Baseline Output" format="tabular" type="data" label="Baseline_Control.txt" />
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
37 </outputs>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
38 <help>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
39 |
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
40
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
41 **Reference**
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
42 http://contra-cnv.sourceforge.net/
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
43
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
44 -----
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
45
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
46 **What it does**
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
47
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
48 Creating a baseline control from multiple samples is can be useful when a matched control is not available. In the CONTRA download page, we have provided several baseline files for some of the platforms that we have tried. Alternatively, the “baseline.py” script that comes with CONTRA can be used to generate a custom baseline file.
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
49
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
50 -----
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
51
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
52 **Parameters**
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
53
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
54 ::
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
55
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
56 -t, --target Target region definition file [REQUIRED] [BED format]
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
57
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
58 -f, --files Files to be converted to baselines [REQUIRED] [BAM]
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
59
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
60 -o, --output Output folder [REQUIRED]
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
61
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
62 -c, --trim Portion of outliers to be removed before calculating
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
63 average [Default: 0.2]
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
64
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
65 -n, --name Output baseline file name [Default: baseline]
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
66
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
67
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
68 </help>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
69 </tool>
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
70
2770f49cb0dc re-uploading contra
Franco Caramia <franco.caramia@petermac.org>
parents:
diff changeset
71