view release on metacpan or  search on metacpan

lib/FAST/Bio/SearchIO/cross_match.pm  view on Meta::CPAN

#
# BioPerl module for FAST::Bio::SearchIO::cross_match
#
# Please direct questions and support issues to <bioperl-l@bioperl.org> 
#
# Cared for by Shin Leong <sleong@watson.wustl.edu>
#
# Copyright Shin Leong
#
# You may distribute this module under the same terms as perl itself

# POD documentation - main docs before the code

=head1 NAME

FAST::Bio::SearchIO::cross_match - CrossMatch-specific subclass of FAST::Bio::SearchIO

=head1 SYNOPSIS

    # Working with iterations (CrossMatch results)
    my $searchIO = FAST::Bio::SearchIO->new( -format => 'cross_match',
                            -file   => "$file.screen.out" )
    while(my $r = $searchIO->next_result) {
      while(my $hit = $r->next_hit) {
	while(my $hsp = $hit->next_hsp) {
           #Do the processing here.
        }
      }
    }
# See FAST::Bio::SearchIO for information about working with Results.

# See L<FAST::Bio::SearchIO>
# for details about working with FAST::Bio::SearchIO.


=head1 DESCRIPTION

This object is a subclass of FAST::Bio::SearchIO
and provides some operations that facilitate working with CrossMatch
and CrossMatch results.

For general information about working with Results, see 
L<FAST::Bio::Search::Result::GenericResult>.

=head1 FEEDBACK

=head2 Mailing Lists

User feedback is an integral part of the evolution of this and other
Bioperl modules. Send your comments and suggestions preferably to
the Bioperl mailing list.  Your participation is much appreciated.

  bioperl-l@bioperl.org                  - General discussion
  http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

=head2 Support 

Please direct usage questions or support issues to the mailing list:

I<bioperl-l@bioperl.org>

rather than to the module maintainer directly. Many experienced and 
reponsive experts will be able look at the problem and quickly 
address it. Please include a thorough description of the problem 
with code and data examples if at all possible.

=head2 Reporting Bugs

Report bugs to the Bioperl bug tracking system to help us keep track
of the bugs and their resolution. Bug reports can be submitted via the
web:

  https://redmine.open-bio.org/projects/bioperl/

=head1 AUTHOR - Shin Leong

Email sleong@watson.wustl.edu

=head1 CONTRIBUTORS