Bio::R...lusters(3pm)

📦
version 3.13.0 · 3 versions
, in debian bookworm, ubuntu jammy, ubuntu noble

💖 Bio::R...lusters — no wait bestie, the real name is Bio::Roary::InflateClusters 💖

okay so this is a page from the User Contributed Perl Documentation and it's genuinely so niche and so good. sit with me for a sec 🫶

✨ NAME ✨

Bio::Roary::InflateClusters — it takes the clusters file from cd-hit and uses it to inflate the output of MCL. that's the whole job. that's the vibe. 💅

🌸 VERSION 🌸

version 3.13.0 🎀

🦋 SYNOPSIS 🦋

the actual deal: you hand it the cd-hit clusters file and you hand it the MCL output, and it inflates that MCL output using the clusters. like blowing up a balloon but the balloon is a cluster and you're a bioinformatician. no cap.

use Bio::Roary::InflateClusters;

my $obj = Bio::Roary::InflateClusters->new(
  clusters_filename  => 'example.clstr',
  mcl_filename       => 'example.mcl',
  output_file        => 'example.output'
);
$obj->inflate;

look at those args bestie, they're giving:

  • clusters_filename — pointing at 'example.clstr' in the example, this is the clusters file from cd-hit
  • mcl_filename — pointing at 'example.mcl', this is the MCL output you're inflating
  • output_file — pointing at 'example.output', this is where the inflated stuff lands

and then you literally just call $obj->inflate; and it does the thing. iconic. 🔥

pro tip from me to you: keep those filenames exact in your head, example.clstr / example.mcl / example.output, that's what the example shows and we do not freestyle the docs. 🙈

👑 AUTHOR 👑

Andrew J. Page <ap13@sanger.ac.uk> — absolute legend, thank you for your service 🫡💜

This software is Copyright (c) 2013 by Wellcome Trust Sanger Institute.

This is free software, licensed under:

The GNU General Public License, Version 3, June 2007

so yes, GPL v3, June 2007, free software, go wild (responsibly, per the license) ⭐

okay that's the whole page, we ate and left no crumbs 💅✨ this was generated from the perl v5.30.0 docs, dated 2019-11-08, under the Bio::R...lusters(3pm) manual name — mwah, love u, bye bestie! 🎀🦋🌸💖

📦 where this page comes from