.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Bio::Tools::Run::BlastPlus 3pm" .TH Bio::Tools::Run::BlastPlus 3pm 2024-03-12 "perl v5.38.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME Bio::Tools::Run::BlastPlus \- A wrapper for NCBI's blast+ suite .SH SYNOPSIS .IX Header "SYNOPSIS" Give standard usage here .SH DESCRIPTION .IX Header "DESCRIPTION" Blast+ is NCBI's successor to the \f(CW\*(C`blastall\*(C'\fR family of programs. .SH FEEDBACK .IX Header "FEEDBACK" .SS "Mailing Lists" .IX Subsection "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. .PP .Vb 2 \& bioperl\-l@bioperl.org \- General discussion \&http://bioperl.org/wiki/Mailing_lists \- About the mailing lists .Ve .SS Support .IX Subsection "Support" Please direct usage questions or support issues to the mailing list: .PP bioperl\-l@bioperl.org .PP 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. .SS "Reporting Bugs" .IX Subsection "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: .PP .Vb 1 \& http://redmine.open\-bio.org/projects/bioperl/ .Ve .SH "AUTHOR \- Mark A. Jensen" .IX Header "AUTHOR - Mark A. Jensen" Email maj \-at\- fortinbras \-dot\- us .PP Describe contact details here .SH CONTRIBUTORS .IX Header "CONTRIBUTORS" Additional contributors names and emails here .SH APPENDIX .IX Header "APPENDIX" The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ .SS new .IX Subsection "new" .Vb 5 \& Title : new \& Usage : my $obj = new Bio::Tools::Run::BlastPlus(); \& Function: Builds a new Bio::Tools::Run::BlastPlus object \& Returns : an instance of Bio::Tools::Run::BlastPlus \& Args : .Ve .SS \fBprogram_version()\fP .IX Subsection "program_version()" .Vb 7 \& Title : program_version \& Usage : $version = $bedtools_fac\->program_version() \& Function: Returns the program version (if available) \& Returns : string representing location and version of the program \& Note : this works around the WrapperBase::version() method conflicting with \& the \-version parameter for SABlast (good argument for not having \& getter/setters for these) .Ve .SS \fBpackage_version()\fP .IX Subsection "package_version()" .Vb 4 \& Title : package_version \& Usage : $version = $bedtools_fac\->version() \& Function: Returns the BLAST+ package version (if available) \& Returns : string representing BLAST+ package version (may differ from version()) .Ve