annotate ceasbw_wrapper.xml @ 1:d9032bb158b9 draft

Add in data manager for CEAS annotation databases.
author pjbriggs
date Wed, 28 Jan 2015 05:04:46 -0500
parents 8b25779ee261
children 695d61decd06
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
1 <tool id="ceasbw" name="CEAS" version="1.0.2-0">
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
2 <description>Annotate intervals and scores with genome features (cistrome CEAS)</description>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
3 <command interpreter="bash">ceasbw_wrapper.sh $bed_file $gdb_file $extra_bed_file $log_output $pdf_report $xls_output
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
4 #if (str($wig_file.ext) == 'bigwig')
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
5 --bigwig $wig_file
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
6 --length $GALAXY_DATA_INDEX_DIR/shared/ucsc/chrom/${bed_file.dbkey}.len
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
7 # else
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
8 --wig $wig_file
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
9 #end if
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
10 #if (str($span) and int(str($span)) > 0)
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
11 --span $span
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
12 #end if
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
13 --sizes $sizes_lower,$sizes_middle,$sizes_upper
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
14 --bisizes $bisizes_lower,$bisizes_upper
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
15 --pf-res $profiling_resolution
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
16 --rel-dist $relative_distance</command>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
17 <requirements>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
18 <requirement type="package" version="1.2.5">python_mysqldb</requirement>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
19 <requirement type="package" version="0.7.1">bx_python</requirement>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
20 <requirement type="package" version="1.0.2.d8c0751">cistrome_ceas</requirement>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
21 </requirements>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
22 <inputs>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
23 <param name="bed_file" type="data" format="bed" label="BED file with ChIP regions" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
24 <param name="wig_file" type="data" format="wig,bigwig" label="WIG or BIGWIG file for wig profiling or genome background annotation" optional="true" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
25 <param name="extra_bed_file" type="data" format="bed" label="BED file with extra regions of interest (e.g. non-coding regions)" optional="true" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
26 <param name="gdb_file" type="select" label="Gene annotation table">
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
27 <options from_data_table="ceas_annotations">
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
28 <filter name="dbkey" type="data_meta" ref="bed_file" key="dbkey" column="0" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
29 <validator type="no_options" message="No tables are available for the selected input"/>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
30 </options>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
31 </param>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
32 <param name="span" type="integer" label="Span from TSS and TTS in the gene-centered annotation (bp)" help="ChIP regions within this range from TSS and TTS are considered when calculating the coverage rates of promoter and downstream by ChIP regions" value="3000" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
33 <param name="sizes_lower" type="integer" label="Lower interval for promoter/downstream sizes for ChIP region annotation (bp)" value="1000" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
34 <param name="sizes_middle" type="integer" label="Middle interval for promoter/downstream sizes (bp)" value="2000" help="Values > 10000bp are automatically fixed to 10000bp" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
35 <param name="sizes_upper" type="integer" label="Upper interval for promoter/downstream sizes (bp)" value="3000" help="Values > 10000bp are automatically fixed to 10000bp" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
36 <param name="bisizes_lower" type="integer" label="Lower interval for bidirectional-promoter sizes for ChIP region annotation (bp)" value="2500" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
37 <param name="bisizes_upper" type="integer" label="Upper interval for bidirectional-promoter sizes (bp)" value="5000" help="Values > 20000bp are automatically fixed to 20000bp" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
38 <param name="profiling_resolution" type="integer" label="Wig profiling resolution (bp)" value="50" help="Warning: a number smaller than the wig interval (resolution) may cause aliasing error" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
39 <param name="relative_distance" type="integer" label="Relative distance to TSS/TTS in wig profiling (bp)" value="3000" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
40 </inputs>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
41 <outputs>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
42 <data name="log_output" format="txt" label="CEAS on ${on_string} (log output)" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
43 <data name="pdf_report" format="pdf" label="CEAS on ${on_string} (PDF report)" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
44 <data name="xls_output" format="interval" label="CEAS on ${on_string} (XLS output)" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
45 </outputs>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
46 <help>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
47 **What it does**
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
48
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
49 CEAS (Cis-regulatory Element Annotation System) is a tool for characterizing genome-wide
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
50 protein-DNA interaction patterns from ChIP-chip and ChIP-Seq of both sharp and broad
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
51 binding factors. It provides statistics on ChIP enrichment at important genome features
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
52 such as specific chromosome, promoters, gene bodies, or exons, and infers genes most
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
53 likely to be regulated by a binding factor.
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
54
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
55 CEAS also enables biologists to visualize the average ChIP enrichment signals over
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
56 specific genomic features, allowing continuous and broad ChIP enrichment to be perceived
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
57 which might be too subtle to detect from ChIP peaks alone.
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
58
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
59 This tool is compatible with the ceasBW version of CEAS from the Cistrome package
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
60 obtained from
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
61
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
62 https://bitbucket.org/cistrome/cistrome-applications-harvard/overview
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
63
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
64 (commit id d8c0751, datestamp 20140929). The CEAS code is under the
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
65 published-packages/CEAS/ subdirectory.
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
66
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
67 Cistrome data files and documentation can be found at
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
68
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
69 http://liulab.dfci.harvard.edu/CEAS/index.html
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
70
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
71 The CEAS user manual is available at http://liulab.dfci.harvard.edu/CEAS/usermanual.html
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
72 </help>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
73 </tool>