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

💖 Bio::Tools::EUtilities::History 💖

okay bestie, so this is a page from User Contributed Perl Documentation — it's the manpage for Bio::T...History(3pm) and we're gonna get into it together, no cap. grab a boba, we're doing NCBI history data today 🧋✨

---

✨ NAME ✨

Bio::Tools::EUtilities::History — a lightweight implementation of the HistoryI interface. and when they say lightweight they mean it: not bound to filehandles, no extraneous methods, none of that extra baggage. just vibes and data 💅

---

🌸 VERSION 🌸

version 1.77 — yes she has a version number and yes she's iconic for it 👑

---

🦋 SYNOPSIS 🦋

#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;

like… look at her. so clean. so readable. the way that has_History just asks and the object just answers 😭💖

---

🎀 DESCRIPTION 🎀

okay so here's the tea ☕ — this class extends methods for any EUtilDataI implementation, and what it does is let instances deal with NCBI history data (WebEnv and query_key). literally that's the whole assignment.

and what do you even do with those? they can be used as parameters for further queries against data sets stored on the NCBI server, much like NCBI's Entrez search history. so if you wanna run complex queries using esearch, retrieve related data using elink, and retrieve large datasets using epost/efetch? yeah. this is the girl for the job 🔥

this class is the simplest implementation and merely holds data for future queries from any HistoryI. so she's not doing the most — she's holding it down, storing the info, being reliable. main character energy but make it humble 🫶

see also Bio::Tools::EUtilities::Query (esearch) and Bio::Tools::EUtilities::LinkSet (elink), which also implement HistoryI. the whole friend group is eating 💜

---

🍓 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, query key

get AND set in one method? we love a multitasker 💅

---

🌈 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

no args, just vibes. she gives you the key and says nothing else 🔑

---

🧚 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

an integer bestie. a whole integer. for this session. don't forget that part, it's giving session-specific 😤

---

⭐ to_string

• Title — to_string
• Usage — $foo->to_string()
• Function — converts current object to string
• Returns — none
• Args — (optional) simple data for text formatting
• Note — Used generally for debugging and for the print_* methods

she converts the object to a string and returns literally nothing. iconic behaviour, honestly. used generally for debugging and for the print_* methods, so like — she's backstage crew, and backstage crew runs the show 💖

---

💌 FEEDBACK 💌

🌸 Mailing lists

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

bioperl-l@bioperl.org               - General discussion
https://bioperl.org/Support.html    - 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. (read: don't dm the dev, post in the group chat 💀)

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. the more detail you give, the faster someone can help — that's just how it works bestie ✨

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

---

💜 AUTHOR 💜

Chris Fields <cjfields@bioperl.org>

---

🌟 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.

---

lowkey important: that's the whole license situation, don't skip it, she's legal binding and she's cute about it 💅

---

and that's the page!! this was perl v5.40.0, dated 2025-01-27, and yes the footer girlie gets her moment too 🎀 thanks for reading bestie, go forth and has_History responsibly 💖✨🦋