.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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::meme 3pm" .TH Bio::AlignIO::meme 3pm "2021-08-15" "perl v5.32.1" "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::meme \- meme sequence input/output stream .SH "SYNOPSIS" .IX Header "SYNOPSIS" Do not use this module directly. Use it via the Bio::AlignIO class. .PP .Vb 7 \& use Bio::AlignIO; \& # read in an alignment from meme \& my $in = Bio::AlignIO\->new(\-format => \*(Aqmeme\*(Aq, \& \-file => \*(Aqmeme.out\*(Aq); \& while( my $aln = $in\->next_aln ) { \& # do something with the alignment \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This object transforms the \*(L"sites sorted by position p\-value\*(R" sections of a meme (text) output file into a series of Bio::SimpleAlign objects. Each SimpleAlign object contains Bio::LocatableSeq objects which represent the individual aligned sites as defined by the central portion of the \*(L"site\*(R" field in the meme file. The start and end coordinates are derived from the \*(L"Start\*(R" field. See Bio::SimpleAlign and Bio::LocatableSeq for more information. .PP This module can only parse \s-1MEME\s0 version 3 and 4. Previous versions have output formats that are more difficult to parse correctly. If the meme output file is not version 3.0 or greater we signal an error. .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 \- Benjamin Berman" .IX Header "AUTHORS - Benjamin Berman" .Vb 2 \& Bbased on the Bio::SeqIO modules by Ewan Birney and others \& Email: benb@fruitfly.berkeley.edu .Ve .SH "APPENDIX" .IX Header "APPENDIX" The rest of the documentation details each of the object methods. Internal methods are usually preceded with an underscore. .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 : Bio::SimpleAlign object with the score() set to the evalue of the \& motif. \& Args : NONE .Ve .SS "write_aln" .IX Subsection "write_aln" .Vb 5 \& Title : write_aln \& Usage : $stream\->write_aln(@aln) \& Function: Not implemented \& Returns : 1 for success and 0 for error \& Args : Bio::SimpleAlign object .Ve