ensembl-hive  2.8.1
XrefParser::HGNCParser Class Reference

Public Member Functions

public void run_script ()
 
public N add_synonyms_for_hgnc ()
 
public Params parse_file_string ()
 

Detailed Description

Description

A parser class to parse the HGNC source.
HGNC is the official naming source for Human.

-data_uri = https://www.genenames.org/cgi-bin/download?col=gd_hgnc_id&col=gd_app_sym&col=gd_app_name&col=gd_prev_sym&col=gd_aliases&col=gd_pub_eg_id&col=gd_pub_ensembl_id&col=gd_pub_refseq_ids&col=gd_ccds_ids&col=gd_lsdb_links&status=Approved&status_opt=2&where=&order_by=gd_app_sym_sort&format=text&limit=&hgnc_dbtag=on&submit=submit
-file_format = TSV
-columns = [
    HGNC ID
    Approved symbol
    Approved name
    Previous symbols
    Alias symbols
    NCBI Gene ID
    Ensembl gene ID
    RefSeq IDs
    CCDS IDs
    Locus specific databases
  ]

A core database adaptor is required.

Synopsis

my $parser = XrefParser::HGNCParser->new($db->dbh);
$parser->run_script( {
source_id => 46,
species_id => 9606,
file => 'hgnc_data.tsv',
dba => $core_dba,
} );

Definition at line 42 of file HGNCParser.pm.

Member Function Documentation

◆ add_synonyms_for_hgnc()

public N XrefParser::HGNCParser::add_synonyms_for_hgnc ( )
  Arg [1]    : hashref : source_id, name, species_id, dead, alias
  Description: Specialized class to add synonyms from HGNC and VGNC data
  Return type: N/A
  Caller     : internal
 
Code:
click to view

◆ parse_file_string()

public Params XrefParser::HGNCParser::parse_file_string ( )
  Arg [1]    : string : input file string
  Description: parses the input string $file into an hash
               string $file is in the format as the example:
               script:project=>ensembl,host=>ens-staging1,dbname=>homo_sapiens_core_70_37,ofhost=>ens-staging1,...
               string until : is ignored, hash is built with keys=>values provided
  Return type: params hashref
  Caller     : internal
 
Code:
click to view

◆ run_script()

public void XrefParser::HGNCParser::run_script ( )
  Description: Runs the HGNCParser
  Return type: none
  Exceptions : throws on all processing errors
  Caller     : ParseSource in the xref pipeline
 
Code:
click to view

The documentation for this class was generated from the following file:
transcript
public transcript()
XrefParser::HGNCParser::run_script
public void run_script()
XrefParser::Database::new
public new()
XrefParser::HGNCParser
Definition: HGNCParser.pm:42
XrefParser::HGNCParser::parse_file_string
public Params parse_file_string()
XrefParser::Database
Definition: Database.pm:8
XrefParser::HGNCParser::add_synonyms_for_hgnc
public N add_synonyms_for_hgnc()