-
-
03 Feb 2021 05:15:14 UTC
- Distribution: BioPerl
- Module version: 1.7.8
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (282 / 7 / 0)
- Kwalitee
Bus factor: 2- License: perl_5
- Activity
24 month- Tools
- Download (7.18MB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 1 contributors- See individual modules
- Dependencies
- AnyDBM_File
- Carp
- Cwd
- DB_File
- Data::Dumper
- Data::Stag
- Digest::MD5
- Dumpvalue
- Error
- Exporter
- Fcntl
- File::Basename
- File::Copy
- File::Path
- File::Spec
- File::Spec::Functions
- File::Temp
- FileHandle
- Getopt::Long
- Graph::Directed
- HTTP::Request::Common
- HTTP::Response
- IO::File
- IO::Handle
- IO::Pipe
- IO::Scalar
- IO::Socket
- IO::String
- IPC::Run
- LWP::UserAgent
- List::MoreUtils
- List::Util
- Math::BigFloat
- Module::Build
- POSIX
- Pod::Usage
- Scalar::Util
- Set::Scalar
- Storable
- Symbol
- Test::Builder
- Test::Builder::Module
- Test::Most
- Test::RequiresInternet
- Text::Balanced
- Text::Wrap
- Tie::Handle
- Tie::RefHash
- Time::HiRes
- UNIVERSAL
- URI
- XML::DOM
- XML::LibXML
- XML::LibXML::Reader
- XML::Parser::PerlSAX
- XML::SAX
- XML::SAX::Base
- XML::SAX::Writer
- XML::Twig
- XML::Writer
- YAML
- base
- constant
- integer
- overload
- parent
- strict
- utf8
- vars
- version
- warnings
- and possibly others
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
Bio::SearchIO::SearchWriterI - Interface for outputting parsed Search results
SYNOPSIS
Bio::SearchIO::SearchWriterI objects cannot be instantiated since this module defines a pure interface.
Given an object that implements the Bio::SearchIO::SearchWriterI interface, you can do the following things with it:
print $writer->to_string( $result_obj, @args );
DESCRIPTION
This module defines abstract methods that all subclasses must implement to be used for outputting results from Bio::Search::Result::ResultI objects.
AUTHOR
Steve Chervitz <sac-at-bioperl.org>
DISCLAIMER
This software is provided "as is" without warranty of any kind.
APPENDIX
The rest of the documentation details each of the object methods.
to_string
Purpose : Produces data for each Search::Result::ResultI in a string. : This is an abstract method. For some useful implementations, : see ResultTableWriter.pm, HitTableWriter.pm, : and HSPTableWriter.pm. Usage : print $writer->to_string( $result_obj, @args ); Argument : $result_obj = A Bio::Search::Result::ResultI object : @args = any additional arguments used by your implementation. Returns : String containing data for each search Result or any of its : sub-objects (Hits and HSPs). Throws : n/a
start_report
Title : start_report Usage : $self->start_report() Function: The method to call when starting a report. You can override it to make a custom header Returns : string Args : none
end_report
Title : end_report Usage : $self->end_report() Function: The method to call when ending a report, this is mostly for cleanup for formats which require you to have something at the end of the document (</BODY></HTML>) for HTML Returns : string Args : none
filter
Title : filter Usage : $writer->filter('hsp', \&hsp_filter); Function: Filter out either at HSP,Hit,or Result level Returns : none Args : string => data type, CODE reference
Module Install Instructions
To install BioPerl, copy and paste the appropriate command in to your terminal.
cpanm BioPerl
perl -MCPAN -e shell install BioPerl
For more information on module installation, please visit the detailed CPAN module installation guide.