.\" Automatically generated by Pod::Man 4.11 (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 .. .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::AlignIO::largemultifasta 3pm" .TH Bio::AlignIO::largemultifasta 3pm "2020-10-28" "perl v5.30.3" "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::AlignIO::largemultifasta \- Largemultifasta MSA Sequence input/output stream .SH "SYNOPSIS" .IX Header "SYNOPSIS" Do not use this module directly. Use it via the Bio::AlignIO class. .SH "DESCRIPTION" .IX Header "DESCRIPTION" This object can transform Bio::SimpleAlign objects to and from largemultifasta flat file databases. This is for the fasta sequence format \s-1NOT\s0 FastA analysis program. To process the pairwise alignments from a FastA (FastX, FastN, FastP, tFastA, etc) use the Bio::SearchIO module. .PP Reimplementation of Bio::AlignIO::fasta modules so that creates temporary files instead of keeping the whole sequences in memory. .SH "FEEDBACK" .IX Header "FEEDBACK" .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 \& https://github.com/bioperl/bioperl\-live/issues .Ve .SH "AUTHORS \- Albert Vilella, Heikki Lehvaslaiho" .IX Header "AUTHORS - Albert Vilella, Heikki Lehvaslaiho" Email: avilella-at-gmail-dot-com, heikki-at-bioperl-dot-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 "next_seq" .IX Subsection "next_seq" .Vb 6 \& Title : next_seq \& Usage : $seq = $stream\->next_seq() \& Function: returns the next sequence in the stream while taking care \& of the length \& Returns : Bio::Seq object \& Args : NONE .Ve .SS "next_aln" .IX Subsection "next_aln" .Vb 6 \& Title : next_aln \& Usage : $aln = $stream\->next_aln() \& Function: returns the next alignment in the stream. \& Returns : L object \- returns 0 on end of file \& or on error \& Args : NONE .Ve .SS "write_aln" .IX Subsection "write_aln" .Vb 5 \& Title : write_aln \& Usage : $stream\->write_aln(@aln) \& Function: writes the $aln object into the stream in largemultifasta format \& Returns : 1 for success and 0 for error \& Args : L object .Ve