Bio::V...::flat(3pm)

💖 Bio::V...::flat 💖

okay bestie, so this is the manual page for Bio::V...::flat(3pm) — yeah that's the abbreviated man name, the actual module is Bio::Variation::IO::flat, and it's part of the Perl documentation that the lovely humans at Bioperl contributed. Sit down, hydrate, let's get into it. 🫶

---

✨ NAME ✨

Bio::Variation::IO::flat — flat file sequence variation input/output stream. that's it, that's the whole vibe. a stream. for flat files. full of sequence variation. 💅

---

✨ SYNOPSIS ✨

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

fr fr, do NOT come for this module directly. it's not the main character, it's the supporting cast. you go through Bio::Variation::IO and let that handle it. periodt. 🎀

---

✨ DESCRIPTION ✨

so like, this object? it can transform Bio::Variation::SeqDiff objects to and from flat file databases. both directions. bi-directional queen. it's giving translator. it's giving bridge. 🌉

---

✨ FEEDBACK ✨

Mailing Lists 💌

User feedback is an integral part of the evolution of this and other Bioperl modules. Send your comments and suggestions preferably to the Bioperl mailing lists. Your participation is much appreciated. (like genuinely, they want to hear from you bestie)

  bioperl-l@bioperl.org                  - General discussion
  http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

Support 🫂

Please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

rather than to the module maintainer directly. the reason? Many experienced and reponsive experts will be able look at the problem and quickly address it. (yes, "reponsive" — that's exactly how it's spelled in the original, we don't fix, we preserve 😌)

and please include a thorough description of the problem with code and data examples if at all possible. give them the receipts. 📝

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:

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

---

✨ AUTHOR - Heikki Lehvaslaiok ✨

Email: heikki-at-bioperl-dot-org

shoutout to Heikki, the icon who wrote this 👑🌸

---

✨ APPENDIX ✨

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ (iykyk, underscore = stay out of the kitchen unless you're the chef 🔪)

next

• Title — next
• Usage — $haplo = $stream->next()
• Function — returns the next seqDiff in the stream
• Returns — Bio::Variation::SeqDiff object
• Args — NONE

literally just "gimme the next one" and it hands you the next seqDiff in the stream. no arguments, no drama, no notes. 💖

write

• Title — write
• Usage — $stream->write(@seqDiffs)
• Function — writes the $seqDiff object into the stream
• Returns — 1 for success and 0 for error
• Args — Bio::Variation::SeqDiff object

you feed it your SeqDiff object(s) and it writes them into the stream. success gives you a 1, error gives you a 0 — classic binary yes/no, we stan a decisive return value ✨

---

remember: don't call this module directly. go through Bio::Variation::IO. that's the whole point. 🙈

---

and that's the page bestie!! 🎀 this little slice of docs was generated by perl v5.32.1 and dated 2021-12-02 — mwah, iconic, no cap. go forth and handle your flat file sequence variation streams responsibly 💜🦋🌸