Bio::A...prodom(3pm)

💖 Bio::AlignIO::prodom — bestie edition 💖

okay so this is Bio::AlignIO::prodom, a lil module living in the BioPerl world (the 3pm perl manpage vibe, yk) that handles prodom sequence input/output stream duties. she's giving ✨sequence I/O✨ and she's very good at it.

---

🌸 SYNOPSIS 🌸

do NOT come for her directly, bestie. she's not that kind of module. you reach her through the Bio::AlignIO class, like:

Do not use this module directly.  Use it via the Bio::AlignIO class.

periodt. that's the whole synopsis. short, sweet, iconic. 💅

---

🦋 DESCRIPTION 🦋

so what does she actually do? this object can transform Bio::Align::AlignI objects to and from prodom flat file databases. that's it, that's the job, and she ate. 🔥

---

🫶 FEEDBACK 🫶

💌 Support

okay so if you've got usage questions or support issues, pls pls pls send them to the mailing list:

bioperl-l@bioperl.org

and NOT to the module maintainer directly, okay? like, respect their peace. 🙈 there are many experienced and reponsive experts on that list who can look at your problem and address it quick. and when you write in, include a thorough description of the problem with code and data examples if at all possible — the more context, the faster the slay. 🎀

🐛 Reporting Bugs

found a bug? report it to the Bioperl bug tracking system so the team can keep track of the bugs and their resolution. bug reports can be submitted via the web at:

https://github.com/bioperl/bioperl-live/issues

go forth and file. 🌈

---

👑 AUTHORS - Peter Schattner

Email: schattner@alum.mit.edu

---

📖 APPENDIX 📖

the rest of this documentation goes into detail on each of the object methods. internal methods are usually preceded with an _ (iykyk, that underscore is the secret handshake). 🤫

⭐ next_aln

• Title : next_aln
• Usage : $aln = $stream->next_aln()
• Function: returns the next alignment in the stream.
• Returns : L<Bio::Align::AlignI> object
• Args : NONE

no args, no drama. she just hands you the next alignment. 🎁

💜 write_aln

• Title : write_aln
• Usage : $stream->write_aln(@aln)
• Function: writes the $aln object into the stream in prodom format ###Not yet implemented!###
• Returns : 1 for success and 0 for error
• Args : L<Bio::Align::AlignI> object

heads up bestie — that ###Not yet implemented!### is doing a LOT of heavy lifting in that line. she is aspirational rn. 💀 just so you know before you build your whole pipeline on her.

---

and that's the whole page, mwah 💋 this was perl v5.32.1, dated 2021-08-15, straight from the Bioperl docs. stay hydrated, read your manpages, and may your streams always be well-formed. 🧚✨