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