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

💖 LICENSE 💖

okay so first things first, the legal bit, and we're gonna be respectful about it because it's important:

Copyright [2015-2018] EMBL-European Bioinformatics Institute

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

---

✨ NAME ✨

So this page is for Bio::DB::HTS::Tabix::Iterator — it's an XS module that wraps around a tabix hts_itr_t. That's the whole vibe. 💅

(and yes bestie, this is part of the User Contributed Perl Documentation collection, we love that for it 🎀)

---

🦋 SYNOPSIS 🦋

ngl, you should not be instantiating one of these manually — it needs a load of pointers 😭. The usage is through Bio::DB::HTS::Tabix:

use feature qw( say );
use Bio::DB::HTS::Tabix;

my $tabix = Bio::DB::HTS::Tabix->new( filename => "gerp_plus_plus_31July2014.gz" );

say $tabix->header;
my $iter = $tabix->query("1:4000005-4000009");

while ( my $n = $iter->next ) {
    say $n;
}

---

🌸 DESCRIPTION 🌸

Okay so here's the tea: this thing is returned from Bio::DB::HTS::Tabix, and the only method you need to care about is 'next'. That's it. That's the whole relationship. 💖

Don't go importing this and calling new on it if you value your sanity — it won't work. 💀

Like, she said what she said. No cap.

🎀 Methods 🎀

• "next" — Returns a string with the line from the tabix iterator. Slay, honestly. ✨

---

👑 AUTHOR 👑

Alex Hodgkins

Rishi Nag <rishi@ebi.ac.uk>

---

And that's the page, bestie! 🫶 This lil' gem was rendered up with perl v5.40.0 on 2024-10-31, from the User Contributed Perl Documentation collection. Stay iconic, go read your tabix files, and don't instantiate things you shouldn't. 🎀💖✨