diff README.markdown @ 0:8b25779ee261 draft

Uploaded initial version to test toolshed.
author pjbriggs
date Wed, 28 Jan 2015 04:50:01 -0500
parents
children 82df5af2995f
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.markdown	Wed Jan 28 04:50:01 2015 -0500
@@ -0,0 +1,39 @@
+CEASbw
+======
+
+XML and wrapper script for the Cistrome version of the CEAS package, which can be
+used to annotate intervals and scores with genome features.
+
+In addition to the `ceas` program, the Cistrome version of the package includes the
+`ceasBW` program which can handle
+
+The tool assumes that the `ceas` and `ceasBW` programs are on the Galaxy user's
+path. The official CEAS website is at
+
+<http://liulab.dfci.harvard.edu/CEAS/index.html>
+
+the Cistrome version can be found via
+
+<https://bitbucket.org/cistrome/cistrome-applications-harvard/overview>
+
+To add to Galaxy add the following to tool_conf.xml:
+
+    <tool file="ceas/ceasbw_wrapper.xml" />
+
+You also need to make a copy of the `ceas.loc` file (sample version is provided
+here) which points to the available GDB files for different genomes. The GDB files
+are essentially SQLite database files containing the RefSeq genes for the genome
+in question.
+
+A limited number of GDB files are available for download from the CEAS website; to
+make new ones, see the section "Build a sqlite3 file with a gene annotation table
+and genome background annotation for CEAS" in the CEAS manual:
+
+<http://liulab.dfci.harvard.edu/CEAS/usermanual.html>
+
+The `ceas.loc` file should be placed in the `tool-data` directory of your Galaxy
+installation.
+
+### Changes ###
+
+1.0.2-0: first version based on our original `ceas` tool.