No commit activity in last 3 years
No release in over 3 years
A Ruby library for reading CD-HIT cluster reports
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 1.3.1
>= 0

Runtime

= 1.4.3
 Project Readme

[[#]] bio-cd-hit-report

Build Status

Clustering sequences with CD-HIT produces a cluster file(.clstr) containing sequence names and their respective clusters. This plugin provides methods for parsing this file.

Note: this plugin is under active development!

Installation

    gem install bio-cd-hit-report

Usage

    require 'bio-cd-hit-report'
   
    cluster_file = "cluster95.clstr"
    report = Bio::CdHitReport.new(cluster_file)

      #print total number of clusters in the report
      puts report.total_clusters  

      #print the cluster members for cluster with id 1
      puts report.get_cluster(1)

      #information for each cluster
      report.each_cluster do |c|
        puts c.name        #print the full cluster name
        puts c.members     #print respective sequence names in the cluster
        puts c.cluster_id  #print the cluster id only
        puts c.size        #print the total number of entries in the cluster
        puts c.rep_seq     #print the name of the representative sequence in this cluster
      end

Project home page

Information on the source tree, documentation, examples, issues and how to contribute, see

http://github.com/georgeG/bioruby-cd-hit-report

The BioRuby community is on IRC server: irc.freenode.org, channel: #bioruby.

Cite

If you use this software, please cite one of

Biogems.info

This Biogem is published at #bio-cd-hit-report

Copyright

Copyright (c) 2013 George Githinji. See LICENSE.txt for further details.