annotate README.txt~ @ 8:5149eb3a89c2

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