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

💖 Bio::Tools::EUtilities::HistoryI — the group chat rundown 💖

okay so bestie, this is the manual page for Bio::Tools::EUtilities::HistoryI, which ships with User Contributed Perl Documentation. Sit down, hydrate, we're talking history data. 🫶

✨ NAME ✨

Bio::Tools::EUtilities::HistoryI — it's a simple extension of the EUtilDataI interface class, made for classes that hold onto NCBI server history data. no cap, that's literally its whole job description.

---

🌸 VERSION 🌸

version 1.77 — that's the one, that's the vibe. 💅

---

🎀 SYNOPSIS 🎀

so here's the little demo, and it should work for any class that is-a HistoryI:

#should work for any class which is-a HistoryI

if ($obj->has_History) {
    # do something here
}

($webenv, $querykey) = $obj->history;

$obj->history($webenv, $querykey);

$webenv = $obj->get_webenv;

$query_key = $obj->get_query_key;

look at her go. iconic behaviour, honestly. ✨

---

🦋 DESCRIPTION 🦋

so this class extends methods for any EUtilDataI implementation, and what that gives you is instances that can deal with NCBI history data — that's WebEnv and query_key. 💖

these two little cuties can be used as parameters for further queries against data sets stored on the NCBI server, which is basically the same energy as NCBI's own Entrez search history. and they matter so much when you wanna:

• run complex queries using esearch
• retrieve related data using elink
• retrieve large datasets using epost/efetch

the simplest implementation is Bio::Tools::EUtilities::History, which holds the history data for epost. and ooh, also check out Bio::Tools::EUtilities::Query (that one's esearch) and Bio::Tools::EUtilities::LinkSet (that one's elink) — they implement HistoryI too. the whole squad, fr fr. 👑

🧚 history

Title    : history
Usage    : my ($webenv, $qk) = $hist->history
Function : Get/Set two-element list of webenv() and query_key()
Returns  : array
Args     : two-element list of webenv, querykey

get it, set it, two-element list of webenv() and query_key(), comes back as an array. you hand it a two-element list of webenv and querykey. done. 💅

🧚 get_webenv

Title    : get_webenv
Usage    : my $webenv = $hist->get_webenv
Function : returns web environment key needed to retrieve results from
           NCBI server
Returns  : string (encoded key)
Args     : none

this one hands you the web environment key you need to go retrieve results from the NCBI server. returns a string — an encoded key, specifically. takes no args, she doesn't need anything from you. lowkey perfect. 🌸

🧚 get_query_key

Title    : get_query_key
Usage    : my $qk = $hist->get_query_key
Function : returns query key (integer) for the history number for this session
Returns  : integer
Args     : none

returns the query key — that's an integer — for the history number for this session. again: no args. independent queen. ✨

---

💬 FEEDBACK 💬

📬 Mailing lists

user feedback is an integral part of the evolution of this module and all the other Bioperl modules, periodt. send your comments and suggestions preferably to the Bioperl mailing list — your participation is so appreciated, bestie, genuinely. 🫶

bioperl-l@bioperl.org               - General discussion
https://bioperl.org/Support.html    - About the mailing lists

🛟 Support

okay important: please direct usage questions or support issues to the mailing list, bioperl-l@bioperl.org, and not directly to the module maintainer. there are so many experienced and responsive experts hanging out there who can look at the problem and address it quickly. please include a thorough description of the problem, with code and data examples if at all possible — the more context, the faster the glow-up. 💖

🐛 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/bio-eutilities/issues

---

👑 AUTHOR 👑

Chris Fields <cjfields@bioperl.org> — the main character who made this. 🎀

---

📜 COPYRIGHT 📜

this software is copyright (c) 2006-2013 by Chris Fields.

this software is available under the same terms as the perl 5 programming language system itself. slay. 🌈

---

ngl bestie, that's the whole page. go forth and hold your history data. 🦋

mwah 💋 — this page is from perl v5.40.0, dated 2025-01-27, and you found it under Bio::T...storyI(3pm). take care of her, she's doing her best. 🫶✨