Bio::EUtilities(3pm)

πŸ“¦
version 1.77 Β· 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

✨ Bio::EUtilities β€” the manual page, but make it cute ✨

okay bestie, gather round, because this is Bio::EUtilities, a Perl manual page (the 3pm kind, so it's a module, not a command you run in your shell πŸ’…). It's the BioPerl low-level API for grabbing data off NCBI's eUtils and storing it. Let's get into it 🫢


🌸 NAME 🌸

Bio::EUtilities β€” it's the BioPerl low-level API for retrieving and storing data from NCBI eUtils. That's the whole vibe. Short, sweet, iconic πŸ’–


⭐ VERSION ⭐

version 1.77 β€” yes ma'am, that's the one πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

So like, the synopsis here isn't gonna hand you a code block, because it's pointing you somewhere else:

See Bio::DB::EUtilities for example usage with NCBI.

That's it. That's the synopsis. Go look at the other module, bestie, it's got the examples πŸ”₯


πŸ’œ DESCRIPTION πŸ’œ

Okay so here's the tea β˜• β€” this distribution is a low-level API for interacting with NCBI's eUtils interface and storing the info that comes back from it.

If you want the query API that actually pulls data down from NCBI, that's Bio::DB::EUtilities. And if you want the general class storage system, that's Bio::Tools::EUtilities. Two different besties for two different jobs, no cap πŸ’…

Now, the heads up part, and I'm saying this with love: this may at some point change to use the XML schema for each class. Like, the maintainers are thinking about it. But they will attempt to keep the current functionality working for backward compatibility β€” unless it becomes problematic. So basically: your code is safe-ish, but don't come for them if the schema thing eventually wins 😭


πŸŽ€ FEEDBACK πŸŽ€

πŸ’Œ Mailing lists

User feedback is, like, an integral part of the evolution of this and other Bioperl modules. Genuinely! Send your comments and suggestions to the Bioperl mailing list, preferably. 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 and support issues to the mailing list:

bioperl-l@bioperl.org

…rather than sliding into the module maintainer's DMs directly, bestie πŸ™ˆ There are so many experienced and responsive experts on there who will be able to look at your problem and address it quickly. And please, please include a thorough description of the problem, with code and data examples, if that's at all possible. The more detail you give, the faster someone can help β€” that's the whole strategy πŸ’…

πŸ› Reporting bugs

Report bugs to the Bioperl bug tracking system, because that's how they keep track of bugs and their resolution. Bug reports can be submitted via the web:

https://github.com/bioperl/bio-eutilities/issues

Go on, drop that issue, it's giving responsible open-source citizen πŸ‘‘


πŸ‘‘ AUTHOR πŸ‘‘

Chris Fields <cjfields@bioperl.org>

The main character who wrote this. Respect πŸ’–


This software is copyright (c) by Chris Fields.

This software is available under the same terms as the perl 5 programming language system itself. So whatever perl's licensing vibe is, that's this one's vibe too. Periodt ✨


okay and that's the whole page!! no filler, all facts, we ate πŸ“ This lovely little doc came from perl v5.40.0, dated 2025-01-27, and it's the Bio::EUtilities(3pm) page from the User Contributed Perl Documentation. Byeee, go read the other EUtilities modules, ily πŸ’œπŸ¦‹

πŸ“¦ where this page comes from