Bio::G...2::Util(3pm)

📦
version 2.56 · 5 versions
, in ubuntu questing

💖 Bio::G...2::Util — bestie's guide to the exported utilities 💖

okay so real quick, before anything else: this is a page from the User Contributed Perl Documentation set, and it lives in section 3pm (that's the Perl module manual section, iykyk). Grab a snack, we're going in 🍓

✨ NAME ✨

Bio::Graphics::Browser2::Util — it's giving exported utilities, periodt. A whole little grab-bag of helper functions. 🎀

🌸 SYNOPSIS 🌸

the vibe check, in code form:

use Bio::Graphics::Browser2::Util;

my $r = modperl_request();

that's it. that's the whole entrance. slay. 💅

🦋 DESCRIPTION 🦋

So here's the tea ☕: this package is a bunch of functions that exist to support the Generic Genome Browser. That's its whole job, its main character energy.

ngl, important caveat: it is not currently designed for external use. So like… it's an inside-job module. Not for randos. 🙈

🌈 FUNCTIONS 🌈

every function, one by one, no skips, no skimming, we're thorough in this house 👑

  • my $r = modperl_request() — hands you back an Apache2::Request object or an Apache::Request object, depending on whichever version of Apache is actually running. Surprise mechanic! 🎁
  • error('message') — literally just prints an error message. That's the whole function. It ate and left no crumbs 💀
  • url_label($yucky_url) — takes a URL string and creates a label.alias for it, but only for URLs starting with 'http' or 'ftp'. The last word (the bit following a /) in the url becomes the label. Returns a string formatted as "url:label". ✨
  • citation(DataSource, 'label, [Language]) — returns a track citation. short king, this one. 📚
  • $id = generate_id — generates a fresh md5 hash of a random value, for use in various IDs. unique-ish, bestie 🎲
  • $string = segment_str($segment) — returns a nicely formatted string in the format chr:start..stop with commas. so pretty. so readable. we love her 🥰

👑 SEE ALSO 👑

go read these too, they're the friend group:

  • Bio::Graphics::Browser
  • Bio::Graphics::Panel
  • Bio::Graphics::Glyph
  • Bio::Graphics::Feature
  • Bio::Graphics::FeatureFile

💜 AUTHOR 💜

Lincoln Stein <lstein@cshl.org> — iconic, we stan 🫶

Copyright (c) 2003 Cold Spring Harbor Laboratory

This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the GPL (either version 1, or at your option, any later version) or the Artistic License 2.0. Refer to LICENSE for the full license text. In addition, please see DISCLAIMER.txt for disclaimers of warranty. 📜

and that's the whole page, bestie!! 🌈⭐

sign-off time: this lil doc came from perl v5.40.0, dated 2024-10-20 🎀 stay hydrated, read your licenses, and never run undocumented internals in prod, mwah 💖

📦 where this page comes from