https://github.com/kylase/circosapi

API-style wrapper for Circos
https://github.com/kylase/circosapi

circos data-visualization perl

Last synced: about 2 months ago
JSON representation

API-style wrapper for Circos

• Host: GitHub
• URL: https://github.com/kylase/circosapi
• Owner: kylase
• License: mit
• Created: 2012-07-06T06:08:01.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2022-07-18T08:53:57.000Z (over 2 years ago)
• Last Synced: 2023-03-25T09:48:09.641Z (over 1 year ago)
• Topics: circos, data-visualization, perl
• Language: Perl6
• Homepage: https://kylase.github.io/CircosAPI
• Size: 1.77 MB
• Stars: 9
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [CircosAPI v0.6 beta](http://kylase.github.com/CircosAPI)

## APIs for [CIRCOS: Circular Genome Data Visualization](http://www.circos.ca)

### Requirements

1. Perl > 5.12

2. Moose

3. JSON::PP

4. String::Util

## Features

* Programmatically generate your Circos graphics via Perl

* Configure your own defaults for your pipelines via JSON

Note: This module is not a syntax checker. You need to know how CIRCOS works.

## Getting Started

### In your script.pl

    #!/usr/bin/perl

    use lib::CircosAPI;

    my $c = CircosAPI->new();

By instantiating a new instance of CircosAPI without any parameters will fill the minimal required parameters based on the defaults.json as found in **defaults** directory. You can change the defaults using a JSON file or pass a Hash to the blocks (shown below).

    

    my $b = Base->new(karyotype => 'hg19');

    my $id = Ideogram->new(radius => '0.95r', thickness => '20p');

    my $c = CircosAPI->new(base => $b, ideogram => $id);

    print $c->compile;

### In your shell

    $ perl script.pl > circos.conf

    $ circos -conf circos.conf

Please read the [API reference](https://kylase.github.io/CircosAPI/reference) for more details on the parameters that you need to provide and the default value for some of the parameters if you do not provide them.