Bio::D...daptor(3pm)

✨ NAME ✨

Bio::DB::SoapEUtilities::DocSumAdaptor — bestie, it's the handle for Entrez SOAP DocSums 💅

This one lives in the User Contributed Perl Documentation (so it's a 3pm page, iykyk) 🎀

---

🌸 SYNOPSIS 🌸

my $fac = Bio::DB::SoapEUtilities->new();
# run a query, returning a DocSumAdaptor
my $docs = $fac->esummary( -db => 'taxonomy',
                           -id => 527031 )->run(-auto_adapt=>1);
# iterate over docsums
while (my $d = $docs->next_docsum) {
   @available_items = $docsum->item_names;
   # any available item can be called as an accessor
   # from the docsum object...watch your case...
   $sci_name = $d->ScientificName;
   $taxid = $d->TaxId;
}

okay so the vibe here is: you build a factory, you run a query, you get back a DocSumAdaptor, and then you just keep pulling docsums off it one by one. Every item the docsum has can be called as an accessor on the docsum object itself — but watch your case, fr fr, the capitalisation has to match exactly 👀

---

🦋 DESCRIPTION 🦋

This adaptor hands you an iterator — that's next_docsum() — plus a bunch of other convenience functions, all for parsing NCBI Entrez EUtility esummary SOAP results. It's giving glorified result-parser and honestly? We're obsessed 💖

---

💌 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 list. Your participation is much appreciated. like genuinely, they want to hear from you 🫶

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.

no cap — slide into the mailing list, not the maintainer's DMs 🙈 and bring receipts (code + data examples), it makes everything so much faster.

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:

http://redmine.open-bio.org/projects/bioperl/

---

👑 AUTHOR - Mark A. Jensen 👑

Email maj -at- fortinbras -dot- us

---

📖 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 = new Bio::DB::SoapEUtilities::DocSumAdaptor();
Function: Builds a new Bio::DB::SoapEUtilities::DocSumAdaptor object
Returns : an instance of Bio::DB::SoapEUtilities::DocSumAdaptor
Args    :

main character energy — it builds the object, it returns the object, the Args are just… empty. Iconic. Periodt. ✨

next_docsum() 🔥

Title   : next_docsum
Usage   :
Function: return the next DocSum from the attached Result
Returns :
Args    :

item_names() 🌈

Title   : item_names
Usage   : @accs = $docsum->item_names
Function: Return a list of items accessible from the
          object
Returns : array of scalar strings
Args    : none

---

and that's the whole page, bestie — you ate that 💜

This little beauty is from perl v5.36.0, dated 2023-01-22, and it's Bio::D...daptor(3pm) in the User Contributed Perl Documentation. bye babes, go parse some docsums 💖✨🎀