.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" 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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" .\" 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::Pseudowise 3pm" .TH Bio::Tools::Run::Pseudowise 3pm "2018-09-14" "perl v5.26.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::Pseudowise \- Object for prediting pseudogenes in a given sequence given a protein and a cdna sequence .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& # Build a pseudowise alignment factory \& my $factory = Bio::Tools::Run::Pseudowise\->new(); \& \& # Pass the factory 3 Bio:SeqI objects (in the order of query \& # peptide and cdna and target_genomic) \& # @genes is an array of GenericSeqFeature objects \& my @genes = $factory\->run($seq1, $seq2, $seq3); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Pseudowise is a pseudogene predition program developed by Ewan Birney http://www.sanger.ac.uk/software/wise2. .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 \- Kiran" .IX Header "AUTHOR - Kiran" Email kiran@fugu\-sg.org .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: holds the program name \& Returns: string \& Args : None .Ve .SS "program_dir" .IX Subsection "program_dir" .Vb 5 \& Title : program_dir \& Usage : $factory\->program_dir(@params) \& Function: returns the program directory, obtained from ENV variable. \& Returns: string \& Args : .Ve .SS "version" .IX Subsection "version" .Vb 6 \& Title : version \& Usage : exit if $prog\->version() < 1.8 \& Function: Determine the version number of the program \& Example : \& Returns : float or undef \& Args : none .Ve .SS "predict_genes" .IX Subsection "predict_genes" .Vb 7 \& Title : predict_genes \& Usage : DEPRECATED. Use $factory\->run instead \& Function: Predict pseudogenes \& Returns : An array of Bio::Seqfeature::Generic objects \& Args : Name of a file containing a set of 3 fasta sequences in the order of \& peptide, cdna and genomic sequences \& or else 3 Bio::Seq objects. .Ve .PP Throws an exception if argument is not either a string (eg a filename) or 3 Bio::Seq objects. If arguments are strings, throws exception if file corresponding to string name can not be found. .SS "run" .IX Subsection "run" .Vb 7 \& Title : run \& Usage : my @feats = $factory\->run($seq1, $seq2, $seq3); \& Function: Executes pseudogene binary \& Returns : An array of Bio::Seqfeature::Generic objects \& Args : Name of a file containing a set of 3 fasta sequences in the order of \& peptide, cdna and genomic sequences \& or else 3 Bio::Seq objects. .Ve .PP Throws an exception if argument is not either a string (eg a filename) or 3 Bio::Seq objects. If arguments are strings, throws exception if file corresponding to string name can not be found. .SS "_run" .IX Subsection "_run" .Vb 7 \& Title : _run \& Usage : Internal function, not to be called directly \& Function: makes actual system call to a pseudowise program \& Example : \& Returns : nothing; pseudowise output is written to a \& temporary file $TMPOUTFILE \& Args : Name of a files containing 3 sequences in the order of peptide, cdna and genomic .Ve .SS "_parse_results" .IX Subsection "_parse_results" .Vb 6 \& Title : _\|_parse_results \& Usage : Internal function, not to be called directly \& Function: Parses pseudowise output \& Example : \& Returns : an reference to an array of Seqfeatures \& Args : the name of the output file .Ve .SS "\fI_setinput()\fP" .IX Subsection "_setinput()" .Vb 6 \& Title : _setinput \& Usage : Internal function, not to be called directly \& Function: Create input files for pseudowise program \& Example : \& Returns : name of file containing dba data input \& Args : Seq objects in the order of query protein and cdna and target genomic sequence .Ve .SS "\fI_query_pep_seq()\fP" .IX Subsection "_query_pep_seq()" .Vb 6 \& Title : _query_pep_seq \& Usage : Internal function, not to be called directly \& Function: get/set for the query sequence \& Example : \& Returns : \& Args : .Ve .SS "\fI_query_cdna_seq()\fP" .IX Subsection "_query_cdna_seq()" .Vb 6 \& Title : _query_cdna_seq \& Usage : Internal function, not to be called directly \& Function: get/set for the query sequence \& Example : \& Returns : \& Args : .Ve .SS "\fI_subject_dna_seq()\fP" .IX Subsection "_subject_dna_seq()" .Vb 5 \& Title : _subject_dna_seq \& Usage : Internal function, not to be called directly \& Function: get/set for the subject sequence \& Example : \& Returns : \& \& Args : .Ve