David Iberri > WWW-Search-HGNC-0.03 > WWW::Search::HGNC

Download:
WWW-Search-HGNC-0.03.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.03   Source  

NAME ^

WWW::Search::HGNC - Access HGNC's database of proteins

SYNOPSIS ^

  use WWW::Search;
  my $search = new WWW::Search('HGNC');

  my @hgnc_ids = [ 9092, 12043 ];
  $search->native_query( \@hgnc_ids );

  while( my $prot = $search->next_result ) {
    printf "Approved symbol: %s\n", $prot->{approved_symbol};
    printf "Approved name: %s\n", $prot->{approved_name};
    printf "HGNC ID: %s\n", $prot->{hgnc_id};
    # ... etc.
  }

DESCRIPTION ^

This module provides access to the HUGO Gene Nomenclature Committee (HGNC) database of human proteins (http://www.gene.ucl.ac.uk/nomenclature/).

If you are unfamiliar with the WWW::Search interface, see the synopsis for an example of how you might use this module. As its first argument, the native_query method accepts either an HGNC ID or a reference to an array of such IDs. Results returned by the next_result method (named $prot above) are WWW::SearchResult objects containing data about the target protein. Each result contains the following fields.

RESULT FIELDS ^

accession_numbers

  @values = @{ $prot->{accession_numbers} };

Corresponds to the 'Accession Numbers' field.

aliases

  @values = @{ $prot->{aliases} };

Corresponds to the 'Aliases' field.

approved_name

  $value = $prot->{approved_name};

Corresponds to the 'Approved Name' field.

approved_symbol

  $value = $prot->{approved_symbol};

Corresponds to the 'Approved Symbol' field.

chromosome

  $value = $prot->{chromosome};

Corresponds to the 'Chromosome' field.

date_approved

  $value = $prot->{date_approved};

Corresponds to the 'Date Approved' field.

date_modified

  $value = $prot->{date_modified};

Corresponds to the 'Date Modified' field.

date_name_changed

  $value = $prot->{date_name_changed};

Corresponds to the 'Date Name Changed' field.

entrez_gene_ids

  @values = @{ $prot->{entrez_gene_ids} };

Corresponds to the 'Entrez Gene ID' field.

mapped_entrez_gene_id

  $value = $prot->{mapped_entrez_gene_id};

Corresponds to the 'Entrez Gene ID (mapped data)' field.

enzyme_ids

  @values = @{ $prot->{enzyme_ids} };

Corresponds to the 'Enzyme IDs' field.

mapped_gdb_id, gdb_id

  $value = $prot->{mapped_gdb_id};
  $value = $prot->{gdb_id};

Corresponds to the 'GDB ID (mapped data)' field.

gene_family_names

  @values = @{ $prot->{gene_family_names} };

Corresponds to the 'Gene Family Name' field.

hgnc_id

  $value = $prot->{hgnc_id};

Corresponds to the 'HGNC ID' field.

locus_type

  $value = $prot->{locus_type};

Corresponds to the 'Locus Type' field.

mgd_id

  $value = $prot->{mgd_id};

Corresponds to the 'MGD ID' field.

misc_ids

  @values = @{ $prot->{misc_ids} };

Corresponds to the 'Misc IDs' field.

mapped_omim_id, omim_id

  $value = $prot->{mapped_omim_id};
  $value = $prot->{omim_id};

Corresponds to the 'OMIM ID (mapped data)' field.

previous_names

  $value = $prot->{previous_names};

Corresponds to the 'Previous Names' field.

previous_symbols

  @values = @{ $prot->{previous_symbols} };

Corresponds to the 'Previous Symbols' field.

pubmed_ids

  @values = @{ $prot->{pubmed_ids} };

Corresponds to the 'Pubmed IDs' field.

mapped_refseq_id

  $value = $prot->{mapped_refseq_id};

Corresponds to the 'RefSeq (mapped data)' field.

refseq_ids

  @values = @{ $prot->{refseq_ids} };

Corresponds to the 'RefSeq IDs' field.

status

  $value = $prot->{status};

Corresponds to the 'Status' field.

mapped_uniprot_id, uniprot_id

  $value = $prot->{mapped_uniprot_id};
  $value = $prot->{uniprot_id};

Corresponds to the 'UniProt ID (mapped data)' field.

AUTHOR ^

David Iberri, <diberri at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-www-hgnc at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-Search-HGNC. 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 WWW::Search::HGNC

You can also look for information at:

COPYRIGHT & LICENSE ^

Copyright 2006 David Iberri, all rights reserved.

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

syntax highlighting: