annotate data_manager/data_manager_ceas_fetch_annotations.xml @ 3:df54f8fcc7a7 draft

Version 1.0.2-3: move to conda-based dependency resolution.
author pjbriggs
date Wed, 28 Feb 2018 10:22:32 -0500
parents f411ce97a351
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
1 <tool id="data_manager_fetch_ceas_annotations" name="Fetch CEAS annotation" version="0.0.1" tool_type="manage_data">
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
2 <requirements>
3
df54f8fcc7a7 Version 1.0.2-3: move to conda-based dependency resolution.
pjbriggs
parents: 0
diff changeset
3 <requirement type="package" version="1.0.2b1">cistrome-ceas</requirement>
0
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
4 </requirements>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
5 <description>Fetch and install annotation databases for CEAS</description>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
6 <command interpreter="python">data_manager_ceas_fetch_annotations.py
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
7 "${out_file}"
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
8 "${description}"</command>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
9 <inputs>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
10 <param name="dbkey" type="genomebuild" label="DBKEY to assign to data" />
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
11 <param type="text" name="unique_id" label="Internal identifier"
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
12 help="Identifier string to associate with the annotation e.g. 'mm9_generic'" />
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
13 <param type="text" name="description" value="" size="50"
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
14 label="Description of annotation"
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
15 help="Text that will be displayed to the user when selecting which annotation to use" />
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
16 <conditional name="reference_source">
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
17 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
18 <option value="web" selected="True">CEAS website</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
19 <option value="server">File on the server</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
20 <option value="from_wig">Generated from wig file</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
21 </param>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
22 <when value="web">
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
23 <param type="select" name="annotation_url">
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
24 <option value="http://liulab.dfci.harvard.edu/CEAS/src/hg18.refGene.gz">hg18</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
25 <option value="http://liulab.dfci.harvard.edu/CEAS/src/hg19.refGene.gz">hg19</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
26 <option value="http://liulab.dfci.harvard.edu/CEAS/src/mm8.refGene.gz">mm8</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
27 <option value="http://liulab.dfci.harvard.edu/CEAS/src/mm9.refGene.gz">mm9</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
28 <option value="http://liulab.dfci.harvard.edu/CEAS/src/dm2.refGene.gz">dm2</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
29 <option value="http://liulab.dfci.harvard.edu/CEAS/src/dm3.refGene.gz">dm3</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
30 <option value="http://liulab.dfci.harvard.edu/CEAS/src/ce4.refGene.gz">ce4</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
31 <option value="http://liulab.dfci.harvard.edu/CEAS/src/ce6.refGene.gz">ce6</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
32 </param>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
33 </when>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
34 <when value="server">
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
35 <param type="text" name="annotation_filename" value="" size="50"
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
36 label="Full path to CEAS annotation table file on disk" optional="False" />
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
37 <param type="boolean" name="create_symlink" truevalue="create_symlink" falsevalue="copy_file" label="Create symlink to orignal data instead of copying" checked="False" />
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
38 </when>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
39 <when value="from_wig">
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
40 <param type="data" format="wig" name="wig_file" value=""
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
41 label="Wig file to use for the background genome annotation"
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
42 help="Will be used as input to build_genomeBG" />
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
43 <param type="select" name="gene_annotation"
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
44 label="Gene annotation from UCSC">
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
45 <option value="refGene">refGene</option>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
46 </param>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
47 </when>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
48 </conditional>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
49 </inputs>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
50 <outputs>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
51 <data name="out_file" format="data_manager_json"/>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
52 </outputs>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
53 <tests>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
54 <test>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
55 <!-- No tests defined, yet -->
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
56 </test>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
57 </tests>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
58 <help>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
59
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
60 .. class:: infomark
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
61
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
62 **What it does**
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
63
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
64 Adds a CEAS gene annotation table file to the *ceas_annotations"* data table. The
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
65 database file can be downloaded from the CEAS website, imported from a file on the
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
66 Galaxy server, or generated from a ``wig`` file in a Galaxy history.
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
67
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
68 **Notice:** If you leave the identifier or description blank then they will be
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
69 generated automatically.
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
70
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
71 ------
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
72
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
73 .. class:: infomark
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
74
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
75 **Fetching, uploading or creating gene annotation table files**
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
76
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
77 The gene annotation table files are SQLite database files which are on the CEAS website:
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
78
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
79 - http://liulab.dfci.harvard.edu/CEAS/usermanual.html
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
80
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
81 The data manager allows you to fetch a pre-built table from the CEAS website; note
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
82 that these are based on the ``RefSeq`` annotation and are only available for a subset
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
83 of genome builds.
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
84
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
85 To create an annotation table for a different genome build or a different annotation,
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
86 use the *Generated from wig* file option. This runs the CEAS utility ``build_genomeBG``
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
87 to make a custom table from a wig file, which represents the genome background (e.g.
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
88 a wig file created from the ``control lambda`` bedgraph file output from MACS2).
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
89
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
90 Alternatively if you already have an existing custom annotation file then this can be
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
91 imported from a path on the Galaxy server.
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
92 </help>
f411ce97a351 Uploaded initial version 1.0.2-2
pjbriggs
parents:
diff changeset
93 </tool>