annotate README.txt @ 8:5149eb3a89c2

Uploaded
author davidmurphy
date Fri, 20 Jan 2012 09:03:40 -0500
parents 4d47ab2b7bcc
children f3462128e87c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
1
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
2 CodonLogo (http://recode.ucc.ie/CodonLogo) is a tool for creating sequence
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
3 logos from biological sequence alignments. It can be run from the command line as a standalone webserver or as a CGI webapp.
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
4
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
5
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
6 For help on the command line interface run
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
7 ./codonlogo --help
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
8
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
9 To build a simple logo run
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
10 ./codonlogo < cap.fa > logo.eps
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
11
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
12
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
13 To run as a standalone webserver at localhost:8080
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
14 ./codonlogo --server
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
15
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
16
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
17 An example file of probabilities is included, examplepriorfile.txt
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
18 It can be used with the following command.
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
19
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
20 ./codonlogo --prior ./examples/Escherichiacoli.txt < cap.fa > logo.eps
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
21
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
22
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
23 examplepriorfile contains the frequencies for codons in human CDS regions.
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
24
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
25
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
26 KNOWN ISSUES:
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
27
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
28 There is a known issue with GPL Ghostscript 9.04 which affects some users which may cause ghostscript to segfault or prevent codonlogos from being generated in anything other than eps format.
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
29
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
30 This is believed to be an issue with ghostscript and a bug report has been submitted to the ghostscript mailing list.
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
31 This is being investigated. if you encounter this problem it's recommended to downgrade to version 9.01 of ghostscript or earlier .
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
32
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
33
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
34
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
35 For converting files to a suitable format the following sites can be used:
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
36
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
37 http://genome.nci.nih.gov/tools/reformat.html
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
38 http://www-bimas.cit.nih.gov/molbio/readseq/
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
39
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
40
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
41
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
42
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
43 -- Distribution and Modification --
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
44 This package is distributed under the new BSD Open Source License.
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
45 Please see the LICENSE.txt file for details on copyright and licensing.
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
46 The CodonLogo source code can be downloaded from
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
47 http://recode.ucc.ie/CodonLogo
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
48
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
49 CodonLogo requires Python 2.6 or 2.7, the corebio python toolkit for
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
50 computational biology (http://code.google.com/p/corebio), and the python
5149eb3a89c2 Uploaded
davidmurphy
parents: 4
diff changeset
51 array package 'numpy' (http://www.scipy.org/Download)