Project

bio-signalp

0.0
No commit activity in last 3 years
No release in over 3 years
bio-signalpwwood/bioruby-signalpHomepageDocumentationSource CodeBug TrackerWiki
A wrapper for the signal peptide prediction algorith SignalP. Not very well supported, but seems to work for the author, at least.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
24,072
Stars
3
Forks
0
Watchers
3
 Releases
Current version
0.3.1
Total releases
6
First release
2011-07-24
Latest release
2014-08-04
 Issues
Open Issues
1
Closed Issues
0
Total Issues
1
Issue Closure Rate
0%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2012-04-26
Reverse Dependencies
2

 Dependencies

Development

bundler
>= 1.0.21, ~> 1.0
jeweler
~> 2.0
rdoc
~> 3.12
rspec
~> 2.8

Runtime

bio
>= 1.4.1, ~> 1.4
bio-logger
~> 1.0
 Project Readme

bio-signalp

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' 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.

  1. Download SignalP and unpack the archive
  2. Modify the signalp script in the unpacked directory. Specific instructions are provided in the script itself.
  3. Add the unpacked directory to your path (or alternately, give the path to the signalp executable to the calculate method)

Then you need to install this bio-gem

gem install bio-signalp

Usage

Usage as a script:

Usage: signalp.rb my.fasta

my.fasta is the name of the fasta file you want to analyse ($stdin also accepted). Default output is all the sequences with their signal sequences cleaved.

This default output can be changed by using one (only) of -s, -S, -v, -f, -F.

-s, --summary                    print a tab separated table indicating if the sequence had a signal peptide results (if Signalp 3 is used, HMM and NN predictions are both given, respectively [default: no]
-S, --bigger-summary             like -s, except also includes where the cleavage site is predicted [default: no]
-v, --verbose-summary            much like -s except more details of the prediction are predicted [default: no]
-f, --filter-in                  filter in: print those sequences that have a signal peptide [default: no]
-F, --filter-out                 filter out: print those sequences that don't have a signal peptide [default: no]
-b, --binary-path SIGNALP_PATH   path to the signalp binary e.g. /usr/local/bin/signalp-4.0/signalp [default: 'signalp' i.e. whatever is on the PATH]

Usage as a programmatic interface

require 'bio-signalp'

# The Plasmodium falciparum ACP sequence is known to have a signal peptide (one that helps direct it to the apicoplast)
acp_sequence = 'MKILLLCIIFLYYVNAFKNTQKDGVSLQILKKKRSNQVNFLNRKNDYNLIKNKNPSSSLKSTFDDIKKIISKQLSVEEDKIQMNSNFTKDLGADSLDLVELIMALEEKFNVTISDQDALKINTVQDAIDYIEKNNKQ'

# Run SignalP. The version is automatically detected
result = Bio::SignalP::Wrapper.new.calculate(acp_sequence) #=> Either a Bio::SignalP::Version3::Result or a Bio::SignalP::Version4::Result object

result.signal? #=> true. ACP has a predicted signal peptide.
result.cleavage_site #=> 17. The Ymax output from SignalP gives the predicted cleavage site.
result.cleave(acp_sequence) #=> 'FKNTQKDGVSLQILKKKRSNQVNFLNRKNDYNLIKNKNPSSSLKSTFDDIKKIISKQLSVEEDKIQMNSNFTKDLGADSLDLVELIMALEEKFNVTISDQDALKINTVQDAIDYIEKNNKQ'. The acp_sequence after signal peptide cleavage.

Copyright

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