NAME

Bio::Grep::Backend::GUUGle - GUUGle back-end

SYNOPSIS

 use Bio::Grep;
 
 my $sbe = Bio::Grep->new('GUUGle');
 
 # generate a GUUGle Bio::Grep database. you have to do this only once.
 # GUUGle does not create a persistent index right now.
 # This function generates an fast index for $sbe->get_sequences
 # and files with a description and the alphabet (only DNA/RNA allowed)
 $sbe->generate_database({ 
   file        => 'ATH1.cdna', 
   description => 'AGI Transcripts',
   datapath    => 'data',
 });

 # search on both strands (GU allowed) 
 # retrieve up- and downstream regions of size 30
 $sbe->search({
   query   => 'AGAGCCCT',
   direct_and_rev_com => 1, 
   upstream           => 30,
   downstream         => 30,
   gumismatches       => 0,
   database           => 'ATH1.cdna',
 });

 my @internal_ids;

 # output all informations we have!
 while ( my $res = $sbe->next_res ) {
    print $res->sequence->id . "\n";
    print $res->mark_subject_uppercase() . "\n";
    print $res->alignment_string() . "\n\n";
    push @internal_ids, $res->sequence_id;
 }
 
 # get the complete sequences as Bio::SeqIO object
 my $seq_io = $sbe->get_sequences(\@internal_ids);
 
 # search for targets (GU allowed)
 $sbe->search({
   query   => 'GAGCCCTTGGGGGGG',
   reverse_complement => 1, 
   gumismatches       => 0,
 });

DESCRIPTION

Bio::Grep::Backend::GUUGle searches for a query in a GUUGle suffix array.

METHODS

See Bio::Grep::Backend::BackendI for inherited methods.

CONSTRUCTOR

Bio::Grep::Backend::GUUGle->new()

This method constructs a GUUGle back-end object and should not used directly. Rather, a back-end should be constructed by the main class Bio::Grep:

my $sbe = Bio::Grep->new('GUUGle');

PACKAGE METHODS

$sbe->available_sort_modes()

Returns all available sort modes as hash. keys are sort modes, values a short description.

$sbe->sort('ga');

Available sort modes in GUUGle:

ga  : 'ascending order of dG'
gd  : 'descending order of dG'

Note that 'ga' and 'gd' require that search results have dG set. Bio::Grep::RNA ships with filters for free energy calculation. Also note that these two sort options require that we load all results in memory.

IMPORTANT NOTES

reverse_complement

GUUGle always searches for the reverse complement. If you specify a query file, Bio::Grep throws an exception if reverse_complement is not set.

mismatches

GUUGle only allows search for exact matches. It counts GU as no mismatch.

maxhits

When "maxhits" is defined, this back-end returns the maxhits first hits.

DIAGNOSTICS

See Bio::Grep::Backend::BackendI for other diagnostics.

GUUGle call failed. Command was: ...

It was not possible to run GUUGle in function search(). Check the search settings. If you want to reproduce the system() call, you can set the environment variable BIOGREPDEBUG. If this variable is set, then the temporary files won't get deleted. Bio::Root::SystemException.

GUUGle searches only for the reverse complement.

You have specified a query file and reverse_complement is not set. Bio::Root::BadParameter.

query_length not set. See -d flag in the...

You have specified a query file and forgot to set query_length. Bio::Root::BadParameter.

SEE ALSO

Bio::Grep::Backend::BackendI Bio::Grep::SearchSettings Bio::Seq

AUTHOR

Markus Riester, <mriester@gmx.de>

LICENSE AND COPYRIGHT

Copyright (C) 2007-2009 by M. Riester.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.