BP_EINFO(1p)

📦
version 1.77 · 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

💖 BP_EINFO 💖

okay so bestie, listen up — this is bp_einfo, part of the User Contributed Perl Documentation situation. it's a lil command-line cutie that goes and asks einfo (that's NCBI's thing) about stuff. you wanna know what databases exist? it'll tell you. you wanna know about one specific database — its field info, or which other NCBI databases it links out to? yeah, it does that too. slay. 🦋

✨ VERSION ✨

this is version 1.77. iconic behavior, no notes. 💅

🌸 SYNOPSIS 🌸

bp_einfo [-d database] [-f Field Code] [-l Link Name] [-o outfile]

like… that's it. that's the whole vibe. look at her go. 🎀

🔥 DESCRIPTION 🔥

so here's the tea, the command line options, laid out one by one:

  • -e, --email — a valid email. NCBI requires this, it's literally their policy, so don't come for me when it's mandatory. 📧
  • -d, --db, --database — the NCBI database you wanna query. default = none, and when it's none it just shows you all the available databases instead, which is honestly a serve.
  • -f, --field — prints out info about one specific field code. default = none.
  • -l, --link — prints out info about one specific link name. default = none.
  • -o, --out — the outfile. default = STDOUT, so it just yells into your terminal like normal. 🫶
  • -h, --help — shows this documentation. hello, you are here.
  • -a, --api_key — your NCBI API key. recommended, bestie, fr fr. 🔑
⚠️ okay important: per NCBI's policy about eutils access, a valid email is required. it is not enforced here — if you don't give one you'll just get a standard warning, whatever — but don't be surprised if this doesn't work after June 1, 2010 unless one is supplied. yes i said what i said. that date is in the original and i am not touching it. 😭

and more rules, because of course:

  • if -d is not specified, then the field and link arguments get ignored, and instead all the available databases get printed. soz to your -f and -l, they're just standing there. 🙈
  • if either link names or field codes (or both!) are specified, then nothing else gets printed out — only the info you actually requested. main character only, no extras. 👑
  • you can specify as many fields and/or links as you want by using multiple -f/-l <ARG> on the command line. stack 'em up, go off. 💜

💬 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, genuinely, we love to see it.

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. 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. (yes, "reponsive" — that's the original spelling, i'm keeping it, it's canon. ✨)

🐛 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> — thank you for your service. 🫡

this software is copyright (c) 2009-2012 by Chris Fields.

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

and that's the whole page, bestie!! 🌈 this doc came to you courtesy of perl v5.40.0 and was dated 2025-01-27 — so yeah, she's a little vintage but she still eats. 💖✨🎀 go query some databases, you got this. 💅🦋

📦 where this page comes from