annotate 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
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 CEASbw
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
2 ======
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
3
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
4 XML and wrapper script for the Cistrome version of the CEAS package, which can be
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
5 used to annotate intervals and scores with genome features.
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
6
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
7 In addition to the `ceas` program, the Cistrome version of the package includes the
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
8 `ceasBW` program which can handle
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
9
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
10 The tool assumes that the `ceas` and `ceasBW` programs are on the Galaxy user's
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
11 path. The official CEAS website is at
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
12
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
13 <http://liulab.dfci.harvard.edu/CEAS/index.html>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
14
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
15 the Cistrome version can be found via
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
16
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
17 <https://bitbucket.org/cistrome/cistrome-applications-harvard/overview>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
18
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
19 To add to Galaxy add the following to tool_conf.xml:
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
20
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
21 <tool file="ceas/ceasbw_wrapper.xml" />
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
22
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
23 You also need to make a copy of the `ceas.loc` file (sample version is provided
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
24 here) which points to the available GDB files for different genomes. The GDB files
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
25 are essentially SQLite database files containing the RefSeq genes for the genome
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
26 in question.
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
27
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
28 A limited number of GDB files are available for download from the CEAS website; to
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
29 make new ones, see the section "Build a sqlite3 file with a gene annotation table
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
30 and genome background annotation for CEAS" in the CEAS manual:
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
31
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
32 <http://liulab.dfci.harvard.edu/CEAS/usermanual.html>
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
33
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
34 The `ceas.loc` file should be placed in the `tool-data` directory of your Galaxy
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
35 installation.
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
36
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
37 ### Changes ###
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
38
8b25779ee261 Uploaded initial version to test toolshed.
pjbriggs
parents:
diff changeset
39 1.0.2-0: first version based on our original `ceas` tool.