view release on metacpan or  search on metacpan

lib/BLASTaid.pm  view on Meta::CPAN

        my $string = $blast->return_report( query => $query );
        print $string;
    }

=head2 type

type: Accessor method to return the BLAST report type as indicated in the BLASTaid index.

    foreach my $query ( $blast->each_report() ) {
        my $type = $blast->type( report => $query );
        print $type;
    }

=head2 undef

undef: Explicitly delete a BLASTaid index object.

    $blast->undef();


=head1 DIAGNOSTICS

A user may encounter messages associated with this module if required method arguments are malformed or missing. Of interest are:

=over

=item C<< no queries found in object >>

[Method each_report found no queries in the object. Did you prime the object with the "new" method first?]

=item C<< return_report cannot locate ... in object >>

[You've requested a query name that is not in the index. Compare the query name you supplied agianst those in the byte index file. They should be identical for BLASTaid to work properly.]

=item C<< ... is a partial report >>

[One of the returned reports is truncated--i.e., there is no terminating "EXIT CODE" line in the BLAST report. Investigate the original BLAST report.]

=item C<< check incoming INDEX format >>

[You've tried to load a byte index file that is corrupt or incorrect. Remove the index file and run BLASTaid again and it will make a new index file.]

=back


=head1 CONFIGURATION AND ENVIRONMENT

BLASTaid requires no configuration files or environment variables. This distribution supplies the perl script "BLASTaid", which is a command line interface for BLASTaid.pm's main functions. The default installation is /usr/bin/. If you are installing...


=head1 DEPENDENCIES

This module uses IO::File & IO::Seekable.


=head1 INCOMPATIBILITIES

None reported.


=head1 BUGS AND LIMITATIONS

No bugs have been reported. This module is limited to parsing WU-BLAST style reports--it does not currently support NCBI or other formats.

Please report any bugs or feature requests to
C<bug-blastaid@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.


=head1 UPDATES

=head2 0.0.2

 -- Version 0.0.1 index files will not work with this version: re-compile the index using this version.
 -- Index order now corresponds to order of queries in the multi-report BLAST file.
 -- ID parse is a little lazier now; previous regex was being to restrictive.
 -- Index output now includes if alignements are in the report (TRUE) or no alignments (FALSE).
 -- Index output now includes type of BLAST per report.
 -- Partial report is no longer restricted to "EXIT CODE 0"; simply requires an EXIT CODE to continue.
 -- The "each_report" method now supports an "ignore" attribute... for ignoring entries without alignments.
 -- Added the following external methods: type; undef.

=head2 0.0.1

 --Inital release to CPAN. Only indexes--no parsing of BLAST reports.

=head1 ACKNOWLEDGMENTS

This module was written by T. Wylie at Washington University School of Medicine's Genome Sequencing Center. It is a small component of a larger code base for the Computational Biology group. Future releases will interact with this module readily. The...

=head1 AUTHOR

Todd Wylie  

C<< <perldev@monkeybytes.org> >>  

L<< http://www.monkeybytes.org >>


=head1 LICENSE AND COPYRIGHT

Copyright (c) 2006, Todd Wylie C<< <perldev@monkeybytes.org> >>. All rights reserved.

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


=head1 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