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

💖 NAME 💖

Bio::DB::GFF::Util::Binning — bestie, it's the binning utility for the Bio::DB::GFF index 🎀

This page ships as part of the User Contributed Perl Documentation, and we're about to make genome range lookups so much faster together ✨

---

🌸 SYNOPSIS 🌸

okay so first you gotta actually pull in the functions you want, no cap:

use Bio::DB::GFF::Util::Binning qw(bin bin_bot bin_top);
my $tier = bin($start,$stop,$min);

that's it. that's the whole vibe. 💅

---

🦋 DESCRIPTION 🦋

so this is a utility module, right, and it exports the functions bin(), bin_bot() and bin_top(). what they do is translate a range on the genome into a named bin — and that bin gets used as an index in the Bio::DB::GFF schema. and the way that index just... makes certain range retrieval queries much faster? iconic. genuinely. 🫶

---

✨ API ✨

the rest of this doc is all about the function calls, so grab a snack 🍓

lowkey important: no calls are exported by default. you have to import them explicitly, bestie. it will not just hand them to you.

• $bin_name = bin($start,$stop,$bin_size) — you give it a start, a stop and a bin size on the genome, and it translates that location into a bin name. and in a list context? it also returns the bin tier name and the position that the bin begins. two-for-one, we love to see it 😌
• $bottom = bin_bot($tier,$start) — hand it a tier name and a range start position, and it gives you back the lower end of the bin range.
• $top = bin_top($tier,$end) — hand it a tier name and the end of a range, and it gives you back the upper end of the bin range.

---

💀 BUGS 💀

None known yet.

(not a single one. main character energy fr fr 🙈✨)

---

🔥 SEE ALSO 🔥

• Bio::DB::GFF,

---

👑 AUTHOR 👑

Lincoln Stein <lstein@cshl.org>.

Copyright (c) 2001 Cold Spring Harbor Laboratory.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

and that's the whole page, bestie 🎀 this was perl v5.32.1, dated 2021-08-15, and it's the Bio::DB::GFF::Util::Binning manpage from the User Contributed Perl Documentation. go bin some ranges, you ate 💅✨