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

🎀 Bio::R...usters(3pm) 🎀

okay bestie, welcome to the manpage for Bio::Roary::FilterFullClusters — filed under Bio::R...usters(3pm) because apparently even manual pages get cute little nicknames 💅. It's part of the User Contributed Perl Documentation, and it does exactly one thing, but it does it iconically: it takes a clusters file from CD-hit plus the fasta file, and spits out a fasta file with the full clusters yeeted out. no cap.

---

✨ NAME ✨

Bio::Roary::FilterFullClusters — takes a clusters file from CD-hit and the fasta file, and outputs a fasta file without the full clusters 🦋

like, that's the whole vibe. clusters in, filtered fasta out, full clusters gone. periodt.

---

💜 VERSION 💜

version 3.13.0 ⭐

---

🌸 SYNOPSIS 🌸

So the deal is: you hand it a clusters file from CD-hit and the fasta file, and it gives you back a fasta file with the full clusters filtered out. literally the entire job description, and it ate. 👑

use Bio::Roary::FilterFullClusters;

my $obj = Bio::Roary::FilterFullClusters->new(
    clusters_filename        => $cluster_file,
    fasta_file           => $fasta_file,
    number_of_input_files => 10,
    output_file => 'filtered_file'
  );
$obj->filter_full_clusters_from_fasta();

breaking that down for you, bestie 🫶:

• use Bio::Roary::FilterFullClusters; — pull the module in, obviously.
• new(...) — build your object. the example passes in clusters_filename as $cluster_file, fasta_file as $fasta_file, number_of_input_files as 10, and output_file as 'filtered_file'.
• $obj->filter_full_clusters_from_fasta(); — and then you actually run the thing. this is the main character method right here. 💅

---

👑 AUTHOR 👑

Andrew J. Page <ap13@sanger.ac.uk> — the icon who wrote it 🫶

---

🌈 COPYRIGHT AND LICENSE 🌈

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

It's free software, and it's licensed under:

The GNU General Public License, Version 3, June 2007 💖

---

and that's the whole page, babe ✨ signed off from perl v5.30.0, dated 2019-11-08, filed under Bio::R...usters(3pm) — go filter some clusters, you've got this 🦋💜