Skip to content

Commit

Permalink
doco
Browse files Browse the repository at this point in the history
  • Loading branch information
Ben J. Woodcroft committed Aug 15, 2012
1 parent e36eb3b commit fd43491
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -2,11 +2,11 @@

A wrapper for the signal peptide prediction algorithm SignalP.

Using ```bio-signalp``` requires SignalP to be locally installed and configured correctly. http://www.cbs.dtu.dk/services/SignalP/ has instructions on how it may be downloaded. This gem works best when the signalp executable is available from the command line (i.e. running 'signalp' works at the command).
Using ```bio-signalp``` requires SignalP to be locally installed and configured correctly. http://www.cbs.dtu.dk/services/SignalP/ has instructions on how it may be downloaded. This gem works best when the signalp executable is available from the command line (i.e. running 'signalp' by itself works at the commandline).

# Installation

First you need to setup SignalP itself. ```bio-signalp`` is tested with SignalP versions 3.0 and 4.0.
First you need to setup SignalP itself. ```bio-signalp``` is tested with SignalP versions 3.0 and 4.0.

1. Download SignalP and unpack the archive
2. Modify the signalp script in the unpacked directory. Specific instructions are provided in the script itself.
Expand Down Expand Up @@ -51,7 +51,7 @@ result.cleavage_site #=> 17. The Ymax output from SignalP gives the predicted cl
result.cleave(acp_sequence) #=> 'FKNTQKDGVSLQILKKKRSNQVNFLNRKNDYNLIKNKNPSSSLKSTFDDIKKIISKQLSVEEDKIQMNSNFTKDLGADSLDLVELIMALEEKFNVTISDQDALKINTVQDAIDYIEKNNKQ'. The acp_sequence after signal peptide cleavage.
```

== Copyright
# Copyright

Copyright (c) 2011-2012 Ben J Woodcroft. See LICENSE.txt for
further details.
Expand Down

0 comments on commit fd43491

Please sign in to comment.