Bio::D...Wrapper(3pm)

📦
version 1.43 · 7 versions
, in ubuntu stonking

💖 Bio::D...Wrapper(3pm) 💖

okay bestie, welcome to the manual page for Bio::DB::Bam::PileupWrapper, filed under the totally abbreviated but still iconic name Bio::D...Wrapper(3pm). she's a Perl module, she's part of the User Contributed Perl Documentation, and she is so much shorter than she looks. let's get into it 🫶

✨ NAME ✨

Bio::DB::Bam::PileupWrapper — the girl who adds high-level methods on top of Bio::DB::Bam::Pileup. literally that's the whole job. she's a glow-up, not a rebuild 💅

✨ SYNOPSIS ✨

ngl the synopsis here is the shiest thing ever, because it does not give you a code block. it just points you elsewhere:

See "The generic fetch() and pileup() methods" in Bio::DB::Sam for usage of the pileup() method.

that's it. that's the synopsis. go read the Bio::DB::Sam docs for how to actually call pileup(), bestie, because she is NOT repeating herself 🌸

✨ DESCRIPTION ✨

so here's the tea ☕ — for the actual documentation of this object's methods, you gotta go see Bio::DB::Bam::Pileup. this page is not the methods page. this page is the why page.

and the why is: this class is used by the high-level API to return Bio::DB::Bam::AlignWrapper objects from the call to alignment() — rather than Bio::DB::Bam::Alignment.

read that again, bestie. same call, ✨fancier✨ return type. alignment() comes back with Bio::DB::Bam::AlignWrapper, not plain old Bio::DB::Bam::Alignment. that's the entire plot twist and honestly? it's giving wrapper-ception. we love a class whose whole personality is "I return the other, extra-sparkly class" 👑

✨ SEE ALSO ✨

the besties in the group chat:

  • Bio::Perl
  • Bio::DB::Sam
  • Bio::DB::Bam::Constants

go follow all three. mutuals only 💜

✨ AUTHOR ✨

Lincoln Stein <lincoln.stein@oicr.on.ca>. <lincoln.stein@bmail.com>

Copyright (c) 2009-2015 Ontario Institute for Cancer Research.

and here's the legal bit, said with love because it's important and it is NOT skippable:

This package and its accompanying libraries are free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0, the Apache 2.0 License, or the GNU General Public License (version 1 or higher). Refer to LICENSE for the full license text.

three licenses, bestie. pick your fighter. slay. 📜✨

aaaaand that's the page 🎀 shoutout to perl v5.42.3, dated 2026-08-19, still stamping Bio::D...Wrapper(3pm) at the bottom like the little footer legend she is. no cap, that's a wrap — bye bestie, go build something 🦋💖

📦 where this page comes from