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

💖 Bio::Search::Result::INFERNALResult — the manual (perl v5.32.1, 2021-08-15) 💖

okay bestie, welcome to the Bio::S...LResult(3pm) page, aka the INFERNALResult era. this is a Perl module doc, so buckle up 🎀

---

✨ NAME ✨

Bio::Search::Result::INFERNALResult — a Result object for INFERNAL results. it's giving search-result energy and honestly? iconic. 👑

---

🌸 SYNOPSIS 🌸

like, usually you don't even make these by hand — you get Results from a SearchIO stream. watch:

# typically one gets Results from a SearchIO stream
use Bio::SearchIO;
my $io = Bio::SearchIO->new(-format => 'infernal',
                            -file   => 't/data/cmsearch_output.txt');
while( my $result = $io->next_result ) {
    while( my $hit = $result->next_hit ) {
      print join(" ", $result->query_name, $result->algorithm, $result->num_hits), "\n";
    }
}

no cap, that's the whole vibe. ✨

---

🦋 DESCRIPTION 🦋

so this object is a specialization of Bio::Search::Result::GenericResult. it inherits all that goodness and then there's one extra method called cm_name. that's it, that's the plot. 💅

---

💌 FEEDBACK 💌

🫶 Mailing Lists

user feedback is, like, an integral part of the evolution of this and other Bioperl modules. send your comments and suggestions (preferably) to the Bioperl mailing list. your participation is so much appreciated, fr fr. 💖

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

🧚 Support

okay so for usage questions and support issues, please direct them to the mailing list:

bioperl-l@bioperl.org

and not to the module maintainer directly, bestie. there are so many experienced and responsive experts on there who can look at your problem and quickly address it. if at all possible, include a thorough description of the problem with code and data examples. the more context the better, periodt. 😭

🐛 Reporting Bugs

report bugs to the Bioperl bug tracking system so we can keep track of the bugs and their resolution. bug reports can be submitted via the web:

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

---

👑 AUTHOR - Paul Cantalupo 👑

---

🌈 APPENDIX 🌈

the rest of the documentation details each of the object methods. internal methods are usually preceded with a _. iykyk. 💀

💅 new

Title   : new
Usage   : my $obj = Bio::Search::Result::INFERNALResult->new();
Function: Builds a new Bio::Search::Result::INFERNALResult object
Returns : Bio::Search::Result::INFERNALResult
Args    : -cm_name    => string, name of covariance model (CM) file.
          plus Bio::Search::Result::GenericResult parameters

• -cm_name — string, the name of the covariance model (CM) file.
• plus all the Bio::Search::Result::GenericResult parameters. yes, all of them. 💖

🎀 cm_name

Title   : cm_name
Usage   : $obj->cm_name($newvalue)
Function: Get/Set value of the covariance model file name (cm_name)
Returns : value of cm_name
Args    : newvalue (optional)

it's a getter and a setter, main character energy fr. pass a new value and it sets; pass nothing and it just returns the cm_name. ⭐

---

lowkey obsessed with how clean this whole thing is. go forth and search, bestie. 🦋

---

and that's the page!! 💜 this was Bio::S...LResult(3pm) from the User Contributed Perl Documentation, perl v5.32.1, dated 2021-08-15. mwah, bye!! 💅✨