/ 
Bio-KEGG-API-0.02
River stage zero No dependents
/ Bio::KEGG::API

NAME

Bio::KEGG::API - Perl interface to KEGG API.

VERSION

Version 0.01

SYNOPSIS

use Bio::KEGG::API;

my $api = Bio::KEGG::API->new();
say $api->database_info(database => 'hsa');

...

DESCRIPTION

This is a simple Perl interface to KEGG API system, please verify which databases are available before using the API.

METHODS

Database information

Displays the current statistics of a given database

options: database, oganism.

<database> = pathway | brite | module | ko | genome | <org> | compound | glycan | reaction | rpair | rclass | enzyme | disease | drug | dgroup | environ | genomes | genes | ligand | kegg

<org> = KEGG organism code or T number

Examples:

my @result = $api->database_info(database => 'kegg');
my @result = $api->database_info(database => 'pathway');
my @result = $api->database_info(database => 'hsa');

Entry list

Returns a list of entry identifiers and associated definition for a given database or a given set of database entries

options: database, oganism.

<database> = pathway | brite | module | ko | genome | <org> | compound | glycan | reaction | rpair | rclass | enzyme | disease | drug | dgroup | environ | organism

<org> = KEGG organism code or T number

Examples:

my @result = $api->entry_list(database => 'pathway');
my @result = $api->entry_list(database => 'pathway', organism => 'hsa');
my @result = $api->entry_list(organism => 'hsa');

Finds entries with matching query keywords or other query data in a given database.

options: database, oganism, query.

<database> = pathway | module | ko | genome | <org> | compound | glycan | reaction | rpair | rclass | enzyme | disease | drug | dgroup | environ | genes | ligand

<org> = KEGG organism code or T number

Example:

my @result = $api->data_search(database => 'genes', query => 'kinase');
my @result = $api->data_search(database => 'reaction', query => 'kinase');
my @result = $api->data_search(database => 'pathway', organism => 'hsa', query => 'kinase');

ID Convertion

Convert KEGG identifiers to/from outside identifiers.

options: target, source.

For gene identifiers: <kegg_db> = <org> <org> = KEGG organism code or T number <outside_db> = ncbi-gi | ncbi-geneid | uniprot

For chemical substance identifiers: <kegg_db> = drug | compound | glycan <outside_db> = pubchem | chebi

Examples:

my @result = $api->id_convertion(target => 'eco', source => 'ncbi-geneid');
my @result = $api->id_convertion(target => 'ncbi-geneid', source => 'eco');

Linked Entries

Find related entries by using database cross-references.

options: target, source.

<target_db> = <database> <source_db> = <database>

<database> = pathway | brite | module | ko | genome | <org> | compound | glycan | reaction | rpair | rclass | enzyme | disease | drug | dgroup | environ

Examples:

my @result = $api->linked_entries(target => 'pathway', source => 'hsa');
my @result = $api->linked_entries(target => 'genes', source => 'K00500');

AUTHOR

Felipe da Veiga Leprevost, <leprevost at cpan.org>

BUGS

Please report any bugs or feature requests to bug-bio-kegg-api at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Bio-KEGG-API. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Bio::KEGG::API

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2014 Felipe da Veiga Leprevost.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.