Bio::T...Builder(3pm)

✨ NAME ✨

Bio::TreeIO::TreeEventBuilder — bestie, this is the little builder that takes events and turns them into Bio::Tree::Tree's and Bio::Tree::Node's 🦋

So like, it lives in the Bio::TreeIO family, and its whole ~thing~ is constructing tree objects out of event streams. Very behind-the-scenes, very main character, no cap.

---

🌸 SYNOPSIS 🌸

# internal use only

Yeah okay so, that's the whole synopsis. It's giving "don't @ me, this is internal" 💅 lowkey iconic of it tbh.

---

🎀 DESCRIPTION 🎀

Okay so here's the vibe: this object takes events and builds a Bio::Tree::TreeI compliant object out of it — made up of Bio::Tree::NodeI objects. ✨

Heads up bestie: the original spells it "makde", and I'm not about to gaslight you, so just know it means made. That's the typo energy we're preserving for accuracy fr fr. 💖

---

💬 FEEDBACK 💬

📬 Mailing Lists

User feedback is literally an integral part of the evolution of this and other Bioperl modules — like, the whole ecosystem thrives on it. Send your comments and suggestions preferably to the Bioperl mailing list. Your participation is much appreciated. 🫶

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 way that so many experienced and responsive experts will be able to look at the problem and quickly address it — that's the dream scenario honestly. 🙈

Please include a thorough description of the problem with code and data examples if at all possible. The more detail you give, the faster someone can slay your bug. 🔥

(Yes, the original says "reponsive" — typo and all, we keep it. 💀)

🐛 Reporting Bugs

Report bugs to the Bioperl bug tracking system to help us keep track of the bugs and their resolution. Bug reports can be submitted via the web:

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

---

👑 AUTHOR - Jason Stajich 👑

Email jason-at-bioperl.org

---

📖 APPENDIX 📖

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

---

🌱 new

Title   : new
Usage   : my $obj = Bio::TreeIO::TreeEventBuilder->new();
Function: Builds a new Bio::TreeIO::TreeEventBuilder object
Returns : Bio::TreeIO::TreeEventBuilder
Args    :

Builds a new Bio::TreeIO::TreeEventBuilder object. Args are empty, so you literally just call it and it exists. Periodt. ✨

🌳 treetype

Title   : treetype
Usage   : $obj->treetype($newval)
Function:
Returns : value of treetype
Args    : newvalue (optional)

Returns the value of treetype. Pass in a newvalue if you want (it's optional, no pressure bestie). 🎀

🍃 nodetype

Title   : nodetype
Usage   : $obj->nodetype($newval)
Function:
Returns : value of nodetype
Args    : newvalue (optional)

Returns the value of nodetype. Newvalue is optional, so do your thing. 💜

---

🧚 SAX methods 🧚

🎬 start_document

Title   : start_document
Usage   : $handler->start_document
Function: Begins a Tree event cycle
Returns : none
Args    : none

Begins a Tree event cycle. That's it, that's the function. It returns nothing and takes nothing — it's giving minimalist queen. 🌈

🏁 end_document

Title   : end_document
Usage   : my @trees = $parser->end_document
Function: Finishes a Phylogeny cycle
Returns : An array  Bio::Tree::TreeI
Args    : none

Finishes a Phylogeny cycle. Returns an array of Bio::Tree::TreeI objects. No args. ✨

🚪 start_element

Title   : start_element
Usage   :
Function:
Example :
Returns :
Args    : $data => hashref with key 'Name'

Args: $data is a hashref with key 'Name'. Everything else is left blank in the docs, so that's exactly what we're telling you — no invented lore here. 🙈

🔚 end_element

Title   : end_element
Usage   :
Function:
Returns : none
Args    : $data => hashref with key 'Name'

Returns none. Args: $data, a hashref with key 'Name'. 🦋

📥 in_element

Title   : in_element
Usage   :
Function:
Example :
Returns :
Args    :

All the fields are blank in the original, bestie — so I'm not gonna make stuff up. It exists, it's here, that's the tea. 💀

📦 within_element

Title   : within_element
Usage   :
Function:
Example :
Returns :
Args    :

Also all blank. Same energy, same honesty. 🫶

✍️ characters

Title   : characters
Usage   : $handler->characters($text);
Function: Processes characters
Returns : none
Args    : text string

Processes characters. Returns none. Takes a text string as its arg. Simple, clean, slays. 🔥

---

Okay and that's the whole page, bestie! This was Bio::T...Builder(3pm) from the User Contributed Perl Documentation — built with perl v5.32.1, dated 2021-08-15. Go build some trees, you absolute icon. 👑💖