Bio::S...riterI(3pm)

💖 Bio::S...riterI(3pm) 💖

okay so bestie, welcome to the manual page for Bio::SearchIO::SearchWriterI, straight out of the User Contributed Perl Documentation section. this one is a vibe, not a real object — it's an interface, and she is iconic for it. 🎀

---

✨ NAME ✨

Bio::SearchIO::SearchWriterI — the Interface for outputting parsed Search results. yes queen, she's the blueprint. 💅

---

🌸 SYNOPSIS 🌸

Bio::SearchIO::SearchWriterI objects cannot be instantiated since this module defines a pure interface. like, she's an idea, not a person. no new() for you, sorry bestie. 😭

but ngl, if you've got an object that implements the Bio::SearchIO::SearchWriterI interface, here's the lil thing you can do with it:

print $writer->to_string( $result_obj, @args );

slay. that's the whole move. ✨

---

🦋 DESCRIPTION 🦋

so like, this module defines abstract methods that all subclasses must implement to be used for outputting results from Bio::Search::Result::ResultI objects. it's giving "contract", it's giving "you WILL implement these, no cap". the way that every subclass has to show up and do the work? obsessed. 👑

---

👑 AUTHOR 👑

Steve Chervitz <sac-at-bioperl.org> — the main character who wrote this. 🫶

---

💀 DISCLAIMER 💀

This software is provided "as is" without warranty of any kind. read that again, fr fr. no promises, no takebacks, no warranty of any kind. 😭

---

🌈 APPENDIX 🌈

The rest of the documentation details each of the object methods. buckle up, we're going method by method, and every single one matters. 🎀

🍓 to_string

• Purpose — Produces data for each Search::Result::ResultI in a string. This is an abstract method. For some useful implementations, see ResultTableWriter.pm, HitTableWriter.pm, and HSPTableWriter.pm.
• Usage — print $writer->to_string( $result_obj, @args );
• Argument — $result_obj = A Bio::Search::Result::ResultI object; @args = any additional arguments used by your implementation.
• Returns — String containing data for each search Result or any of its sub-objects (Hits and HSPs).
• Throws — n/a

like, n/a on throws? we love a low-drama method. 💜

🧚 start_report

• Title — start_report
• Usage — $self->start_report()
• Function — The method to call when starting a report. You can override it to make a custom header.
• Returns — string
• Args — none

custom header?? the personalization era. go off. ✨

🌸 end_report

• Title — end_report
• Usage — $self->end_report()
• Function — The method to call when ending a report, this is mostly for cleanup for formats which require you to have something at the end of the document (</BODY></HTML>) for HTML
• Returns — string
• Args — none

she's the "okay bye gotta go" text at the end of the group chat. required by some formats, lowkey essential. 🫶

💅 filter

• Title — filter
• Usage — $writer->filter('hsp', \&hsp_filter);
• Function — Filter out either at HSP, Hit, or Result level
• Returns — none
• Args — string => data type, CODE reference

three whole levels of filtering?? HSP, Hit, and Result? she contains multitudes. 🔥

---

quick reminder bestie: Bio::SearchIO::SearchWriterI is a pure interface, so don't try to instantiate her directly. implement the methods in a subclass, then go feral. 💖

---

and that's the page!! this gorgeous piece of documentation comes to you via perl v5.32.1, dated 2021-08-15, and it's the Bio::S...riterI(3pm) manual page. mwah. 💋 🌈 ⭐ 💜