annotate jamm.xml @ 1:243f75d0ed6e draft default tip

Uploaded. Includes new release 1.0.7 with fixed optional controls.
author messersc
date Thu, 19 Feb 2015 05:39:45 -0500
parents d42f4d78c85e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
1 <tool id="jamm" name="JAMM" version="1.0.7">
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
2 <description>Calls peaks on NGS data</description>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
3 <requirements>
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
4 <requirement>R</requirement>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
5 <requirement>perl</requirement>
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
6 </requirements>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
7 <command interpreter="python">
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
8 <![CDATA[
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
9 jammwrapper.py -i
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
10 #for $x in $input
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
11 ${x.replicate.file_name} #end for
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
12
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
13 #for $x in $control
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
14 -c ${x.controlreplicate.file_name} #end for
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
15
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
16 -g ${genomeSizeFile}
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
17 -o $output
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
18 -of $outputfiltered
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
19 -m $mode
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
20 -r $resolution
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
21 -p $processes
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
22 -t $type
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
23 -f $fraglen
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
24 -b $binsize
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
25 ]]>
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
26 </command>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
27
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
28 <stdio>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
29 <!-- Wrapper ensures anything other than zero is an error -->
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
30 <exit_code range="1:" />
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
31 <exit_code range=":-1" />
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
32 </stdio>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
33
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
34 <inputs>
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
35 <repeat name="input" title="Sample Replicates">
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
36 <param name="replicate" type="data" format="bed"></param>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
37 </repeat>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
38
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
39 <repeat name="control" title="Negative Control Replicates (e.g. input) - optional">
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
40 <param name="controlreplicate" type="data" format="bed"></param>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
41 </repeat>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
42
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
43 <param name="genomeSizeFile" type="data" label="File indicating chromosome sizes" description="Chromosome size"></param>
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
44 <param name="mode" type="select" label="Mode (normal or narrow)">
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
45 <option value="normal">normal</option>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
46 <option value="narrow">narrow</option>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
47 </param>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
48 <param name="resolution" type="select" label="Resolution (peak or region)">
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
49 <option value="peak">peak</option>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
50 <option value="region">region</option>
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
51 <option value="window">window</option>
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
52 </param>
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
53 <param name="type" type="select" label="Type of data (Single or paired. Paired requires BEDPE datasets)">
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
54 <option value="single" selected="true">single</option>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
55 <option value="paired">paired</option>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
56 </param>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
57 <param name="fraglen" type="text" value="ns" label="Fragment length. Estimated by default (ns)" />
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
58 <param name="binsize" type="text" value="ns" label="Bin size. Estimated by default (ns)" />
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
59 <param name="processes" type="text" value="4" label="Number of threads used by R" help="Depending on your Galaxy configuration, 1 should be safe and up to 4 should be fine." />
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
60
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
61 </inputs>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
62
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
63 <outputs>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
64 <data name="output" format="tabular" label="Narrowpeak tabular" />
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
65 <data name="outputfiltered" format="tabular" label="Narrowpeak tabular filtered" />
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
66 </outputs>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
67
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
68 <tests>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
69 <test>
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
70 <param name="replicate" value="test1.bed" ftype="bed"/>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
71 <param name="replicate" value="test2.bed" ftype="bed"/>
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
72 <param name="genomeSizeFile" value="chrSizes21.csize"/>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
73 <output name="output" ftype="tabular">
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
74 <assert_contents>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
75 <has_text text="chr21" />
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
76 </assert_contents>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
77 </output>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
78 </test>
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
79 <test>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
80 <param name="replicate" value="test1.bed" ftype="bed"/>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
81 <param name="replicate" value="test2.bed" ftype="bed"/>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
82 <param name="controlreplicate" value="control.bed" />
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
83 <param name="genomeSizeFile" value="chrSizes21.csize"/>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
84 <param name="resolution" value="region" />
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
85 <output name="output" ftype="tabular">
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
86 <assert_contents>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
87 <has_text text="chr21" />
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
88 </assert_contents>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
89 </output>
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
90 </test>
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
91 </tests>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
92
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
93 <citations>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
94 <!-- Example of annotating a citation using a DOI. -->
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
95 <citation type="doi">10.1093/bioinformatics/btu568</citation>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
96 </citations>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
97 <help>
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
98 **What it does**
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
99 JAMM calls peaks on NGS data, i.e. for finding binding sites.
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
100
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
101 .. class:: warningmark
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
102
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
103 This tool requires files in *bed* format.
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
104
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
105 .. class:: infomark
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
106
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
107 If you are just starting out, you can find some sensible parameter choices here:
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
108
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
109 http://code.google.com/p/jamm-peak-finder/wiki/Usage#Examples
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
110
1
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
111 * ChIP-Seq TF: everything default
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
112 * ChIP-Seq HM: Binsize=200
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
113 * ChIP-Seq Broad HM: Binsize=200 Resolution=region
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
114 * ChIP-Seq Very Broad HM: Binsize=10000 Resolution=window
243f75d0ed6e Uploaded.
messersc
parents: 0
diff changeset
115 * DNase-seq: Fragment length=1
0
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
116 </help>
d42f4d78c85e Uploaded
messersc
parents:
diff changeset
117 </tool>