Bio::V...IO::xml(3pm)

💖 Bio::Variation::IO::xml — bestie edition 💖

okay so you found your way to Bio::V...IO::xml(3pm) from the User Contributed Perl Documentation and honestly? welcome. this is the XML sequence variation input/output stream, and i'm about to walk you through it like we're texting at 1am 🦋

---

✨ NAME ✨

Bio::Variation::IO::xml — it's an XML sequence variation input/output stream, periodt 💅

---

🌸 SYNOPSIS 🌸

Do not use this module directly. like, i mean it bestie 😭 use it via the Bio::Variation::IO class instead. iykyk.

---

🎀 DESCRIPTION 🎀

This object can transform Bio::Variation::SeqDiff objects to and from XML file databases. slay ✨

The XML format, although consistent, is still evolving — it's giving "we're working on it, glow-up in progress" 🌱 The current DTD for it is at <http://www.ebi.ac.uk/mutations/DTDE/seqDiff.dtd>.

---

💜 REQUIREMENTS 💜

To use this code you need the module XML::Twig which creates an interface to XML::Parser to read XML, plus modules XML::Writer and IO::String to write XML out. so like, install your little friends first, no cap 🫶

---

🦋 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, fr fr 💖

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. 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. give them the whole tea, not just a sip 🍵

🐛 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

---

🌈 APPENDIX 🌈

The rest of the documentation details each of the object methods. Internal methods are usually preceded with a _ 👀

🌟 next

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

🌟 write

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

---

and that's the whole page, bestie!! this one's running on perl v5.32.1, dated 2021-12-02, and it's the Bio::V...IO::xml(3pm) doc — go forth and stream that XML 💖✨🎀