/ 
Bio-Palantir-0.211420
River stage zero No dependents
/ Bio::Palantir::Parser::Cluster

NAME

Bio::Palantir::Parser::Cluster - BiosynML DTD-derived internal class

VERSION

version 0.211420

SYNOPSIS

# TODO

DESCRIPTION

# TODO

ATTRIBUTES

genes

ArrayRef of Bio::Palantir::Parser::Gene

locations

Bio::Palantir::Parser::Location composed object

METHODS

count_genes

Returns the number of Genes of the Cluster.

# $cluster is a Bio::Palantir::Parser::Cluster
my $count = $cluster->count_genes;

This method does not accept any arguments.

all_genes

Returns all the Genes of the Cluster (not an array reference).

# $cluster is a Bio::Palantir::Parser::Cluster
my @genes = $cluster->all_genes;

This method does not accept any arguments.

get_gene

Returns one Gene of the Cluster by its index. You can also use negative index numbers, just as with Perl's core array handling. If the specified Gene does not exist, this method will return undef.

# $cluster is a Bio::Palantir::Parser::Cluster
my $gene = $cluster->get_gene($index);
croak "Gene $index not found!" unless defined $gene;

This method accepts just one argument (and not an array slice).

next_gene

Shifts the first Gene of the array off and returns it, shortening the array by 1 and moving everything down. If there are no more Genes in the array, returns undef.

# $cluster is a Bio::Palantir::Parser::Cluster
while (my $gene = $cluster->next_gene) {
    # process $gene
    # ...
}

This method does not accept any arguments.

name

Returns the value of the element <name>.

# $cluster is a Bio::Palantir::Parser::Cluster
my $name = $cluster->name;

This method does not accept any arguments.

shortname

Returns the value of the element <shortname>.

# $cluster is a Bio::Palantir::Parser::Cluster
my $shortname = $cluster->shortname;

This method does not accept any arguments.

status

Returns the value of the element <status>.

# $cluster is a Bio::Palantir::Parser::Cluster
my $status = $cluster->status;

This method does not accept any arguments.

type

Returns the value of the element <type>.

# $cluster is a Bio::Palantir::Parser::Cluster
my $type = $cluster->type;

This method does not accept any arguments.

identifier

Returns the value of the element <identifier>.

# $cluster is a Bio::Palantir::Parser::Cluster
my $identifier = $cluster->identifier;

This method does not accept any arguments.

citation

Returns the value of the element <citation>.

# $cluster is a Bio::Palantir::Parser::Cluster
my $citation = $cluster->citation;

This method does not accept any arguments.

sequence

Returns the value of the element <sequence>.

# $cluster is a Bio::Palantir::Parser::Cluster
my $sequence = $cluster->sequence;

This method does not accept any arguments.

AUTHOR

Loic MEUNIER <lmeunier@uliege.be>

COPYRIGHT AND LICENSE

This software is copyright (c) 2019 by University of Liege / Unit of Eukaryotic Phylogenomics / Loic MEUNIER and Denis BAURAIN.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.