.\" Automatically generated by Pod::Man 4.14 (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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Bio::Tools::Run::Glimmer 3pm" .TH Bio::Tools::Run::Glimmer 3pm "2023-01-22" "perl v5.36.0" "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::Glimmer \- Wrapper for local execution of Glimmer, GlimmerM and GlimmerHMM. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 11 \& # glimmer2 \& my $factory = \& Bio::Tools::Run::Glimmer\->new(\*(Aq\-program\*(Aq => \*(Aqglimmer3\*(Aq, \& \*(Aq\-model\*(Aq => \*(Aqmodel.icm\*(Aq); \& # glimmer3 \& my $factory = \& Bio::Tools::Run::Glimmer\->new(\*(Aq\-program\*(Aq => \*(Aqglimmer2\*(Aq, \& \*(Aq\-model\*(Aq => \*(Aqmodel.icm\*(Aq); \& # glimmerm \& my $factory = \& Bio::Tools::Run::Glimmer\->new(\*(Aq\-program\*(Aq => \*(Aqglimmerm\*(Aq); \& \& # glimmerHMM \& my $factory = \& Bio::Tools::Run::Glimmer\->new(\*(Aq\-program\*(Aq => \*(AqglimmerHMM\*(Aq); \& \& # Pass the factory Bio::Seq objects \& # returns a Bio::Tools::Glimmer object \& my $glimmer = $factory\->run($seq); \& or \& my $glimmer = $factor\->run(@seq); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Wrapper module for the Glimmer family of programs. Should work with all currently available flavors: Glimmer, GlimmerM and GlimmerHMM. However, only Glimmer 2.X and 3.X have been tested. .PP Glimmer is open source and available at . .PP GlimmerM is open source and available at . .PP GlimmerHMM is open source and available at . .PP Note that Glimmer 2.X will only process the first sequence in a fasta file (if you \fBrun()\fR more than one sequence at a time, only the first will be processed). .PP Note that Glimmer 3.X produces two output files. This module only passes the .predict file to Bio::Tools::Glimmer. .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 one of the Bioperl mailing lists. 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 \&\fIbioperl\-l@bioperl.org\fR .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 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 Johnson" .IX Header "AUTHOR - Mark Johnson" .Vb 1 \& Email: johnsonm\-at\-gmail\-dot\-com .Ve .SH "APPENDIX" .IX Header "APPENDIX" The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ .SS "program_name" .IX Subsection "program_name" .Vb 5 \& Title : program_name \& Usage : $factory>program_name() \& Function: gets/sets the program name \& Returns: string \& Args : string .Ve .SS "program_dir" .IX Subsection "program_dir" .Vb 5 \& Title : program_dir \& Usage : $factory\->program_dir() \& Function: gets/sets the program dir \& Returns: string \& Args : string .Ve .SS "model" .IX Subsection "model" .Vb 5 \& Title : model \& Usage : $factory>model() \& Function: gets/sets the name of the model (icm) file \& Returns: string \& Args : string .Ve .SS "new" .IX Subsection "new" .Vb 5 \& Title : new \& Usage : $glimmer\->new(@params) \& Function: creates a new Glimmer factory \& Returns: Bio::Tools::Run::Glimmer \& Args : .Ve .SS "run" .IX Subsection "run" .Vb 5 \& Title : run \& Usage : $obj\->run($seq_file) \& Function: Runs Glimmer/GlimmerM/GlimmerHMM \& Returns : A Bio::Tools::Glimmer object \& Args : An array of Bio::PrimarySeqI objects .Ve .SS "_run" .IX Subsection "_run" .Vb 5 \& Title : _run \& Usage : $obj\->_run() \& Function: Internal(not to be used directly) \& Returns : An instance of Bio::Tools::Glimmer \& Args : file name, sequence identifier (optional) .Ve .SS "_write_seq_file" .IX Subsection "_write_seq_file" .Vb 5 \& Title : _write_seq_file \& Usage : obj\->_write_seq_file($seq) or obj\->_write_seq_file(@seq) \& Function: Internal(not to be used directly) \& Returns : Name of a temp file containing program output \& Args : One or more Bio::PrimarySeqI objects .Ve