view release on metacpan or  search on metacpan

lib/Bio/Das/ProServer/SourceAdaptor/Transport/bioseqio.pm  view on Meta::CPAN

1;

__END__

=head1 NAME

Bio::Das::ProServer::SourceAdaptor::Transport::bioseqio - A ProServer
transport module that works off any flat file that Bio::SeqIO
supports.

=head1 VERSION

$Revision: 687 $

=head1 SYNOPSIS

=head1 DESCRIPTION

NB: This is *not* what you want to use if your files are large.  As an
example, a single query for "Z261_HUMAN" on the complete Swissprot
file "sprot42.dat" takes several minutes.

=head1 SUBROUTINES/METHODS

=head2 init

=head2 query

=head1 DIAGNOSTICS

=head1 CONFIGURATION AND ENVIRONMENT

For sequential querying flat files, the following
configuration entries are needed:

  filename	The name of the flat file to search.

  format	The format of the flat file.

If using Bio::DB::Flat (this is depedent on the existance of
the 'index' configuration entry), the following additional
configuration entries are needed:

  index       The type of index to create and/or use ('bdb' or
              'binarysearch').  Corresponds to the '-index'
              option of Bio::DB::Flat::new().

  dbname      The name of the database to create and/or
              use.  Corresponds to the '-dbname' option of
              Bio::DB::Flat::new().

  dbroot      The directory where the database index is
              or will be located.  Corresponds to the
              '-directory' option of Bio::DB::Flat::new().

=head1 DEPENDENCIES

=head1 INCOMPATIBILITIES

=head1 BUGS AND LIMITATIONS

=head1 AUTHOR

Andreas Kahari, andreas.kahari@ebi.ac.uk

=head1 LICENSE AND COPYRIGHT