Mercurial > repos > pjbriggs > ceas

annotate README.rst @ 9:4c3b7130dbbb draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Bump version to 1.0.2-3 to reflect dependency updates.
author pjbriggs
date Tue, 18 Oct 2016 09:24:30 -0400
parents 4e2883bb058d
children b5d686bb9d6f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
1 CEAS: Cis-regulatory Element Annotation System
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
2 ==============================================
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
3
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
4 Galaxy tool wrapper for the CEAS (Cis-regulatory Element Annotation System), which
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
5 can be used to annotate intervals and scores with genome features.
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
6
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
7 This tool uses the Cistrome version of the package, which provides two versions of
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
8 the core program: in addition to the ``ceas`` program (the same as that available
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
9 from the main CEAS website), it also includes the ``ceasBW`` program (which can handle
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
10 bigwig input).
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
11
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
12 The tool assumes that the ``ceas`` and ``ceasBW`` programs are on the Galaxy user's
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
13 path.
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
14
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
15 The official CEAS website is at:
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
16
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
17 - http://liulab.dfci.harvard.edu/CEAS/index.html
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
18
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
19 The Cistrome version can be found via
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
20
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
21 - https://bitbucket.org/cistrome/cistrome-applications-harvard/overview
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
22
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
23 Automated installation
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
24 ======================
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
25
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
26 Installation via the Galaxy Tool Shed will take care of installing the tool wrapper
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
27 and the CEAS programs, and setting the appropriate environment variables.
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
28
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
29 In addition this will also install a data manager which can be used to install
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
30 reference GDB data files necessary for the tool.
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
31
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
32 Manual Installation
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
33 ===================
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
34
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
35 There are two files to install:
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
36
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
37 - ``ceas_wrapper.xml`` (the Galaxy tool definition)
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
38 - ``ceas_wrapper.sh`` (the shell script wrapper)
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
39
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
40 The suggested location is in a ``tools/ceas/`` folder. You will then
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
41 need to modify the ``tools_conf.xml`` file to tell Galaxy to offer the tool
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
42 by adding the line:
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
43
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
44 <tool file="ceas/ceasbw_wrapper.xml" />
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
45
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
46 You also need to make a copy of the ``ceas.loc`` file (a sample version is
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
47 provided here) which points to the available GDB files for different genomes.
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
48
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
49 This file should be placed in the ``tool-data`` directory of your Galaxy
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
50 installation.
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
51
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
52 Reference Data
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
53 ==============
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
54
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
55 CEAS requires reference data in the form of GDB files (essentially, SQLite database
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
56 files) containing the RefSeq genes for the genome in question.
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
57
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
58 A limited number of GDB files are available for download from the CEAS website; to
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
59 make new ones, see the section "Build a sqlite3 file with a gene annotation table
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
60 and genome background annotation for CEAS" in the CEAS manual:
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
61
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
62 - http://liulab.dfci.harvard.edu/CEAS/usermanual.html
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
63
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
64 History
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
65 =======
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
66
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
67 ========== ======================================================================
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
68 Version Changes
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
69 ---------- ----------------------------------------------------------------------
9
4c3b7130dbbb Bump version to 1.0.2-3 to reflect dependency updates.
pjbriggs
parents: 4
diff changeset
70 1.0.2-3 - Switch to getting R 3.1.2 and bx-python 0.7.1 dependencies from the
4c3b7130dbbb Bump version to 1.0.2-3 to reflect dependency updates.
pjbriggs
parents: 4
diff changeset
71 toolshed (rather than installing as part of the tool)
4
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
72 1.0.2-2 - Major updates to fix various bugs, add tests and enable ceasBW to
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
73 be used without an existing chromosome sizes file.
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
74 1.0.2-1 - Modified to work with Cistrome-version of CEAS (includes additional
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
75 'ceasBW' program which can take bigWig input)
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
76 1.0.2-0 - Initial version.
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
77 ========== ======================================================================
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
78
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
79 Developers
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
80 ==========
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
81
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
82 This tool is developed on the following GitHub repository:
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
83 https://github.com/fls-bioinformatics-core/galaxy-tools/tree/master/ceas
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
84
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
85 For making the "Galaxy Tool Shed" http://toolshed.g2.bx.psu.edu/ tarball I use
4e2883bb058d Synchronise version with one on main toolshed (version of 30/06/2015)
pjbriggs
parents:
diff changeset
86 the ``package_ceas.sh`` script.