ensembl-hive  2.7.0
XrefMapper::SubmitMapper Class Reference

Public Member Functions

public new ()
 
public mapper ()
 
public void dump_seqs ()
 
public no_dump_xref ()
 
public Arrayref get_stored_methods ()
 
public dump_xref ()
 
public void dump_ensembl ()
 
public fetch_alt_allele_list ()
 
public fetch_and_dump_seq_via_toplevel ()
 
public fetch_and_dump_seq_via_genes ()
 
public String set_methods ()
 
public Scalar jobcount ()
 
public method ()
 
public void build_list_and_map ()
 
public void fix_mappings ()
 
public void run_mapping ()
 
public nofarm ()
 
public check_err ()
 
public void submit_depend_job ()
 
public remove_all_old_output_files ()
 

Detailed Description

Definition at line 8 of file SubmitMapper.pm.

Member Function Documentation

◆ build_list_and_map()

public void XrefMapper::SubmitMapper::build_list_and_map ( )
  Arg[1]: xref object which holds info on method and files.
  Description: runs the mapping of the list of files with species methods
  Returntype : none
  Exceptions : none
  Caller     : general
 
Code:
click to view

◆ check_err()

public XrefMapper::SubmitMapper::check_err ( )

Undocumented method

Code:
click to view

◆ dump_ensembl()

public void XrefMapper::SubmitMapper::dump_ensembl ( )
  Description: Dumps the ensembl data to a file in fasta format.
  Returntype : none
  Exceptions : none
  Caller     : dump_seqs
 
Code:
click to view

◆ dump_seqs()

public void XrefMapper::SubmitMapper::dump_seqs ( )
  Arg[1]: xref object which holds info needed for the dump of xref
  Description: Dumps out the files for the mapping. Xref object should hold
              the value of the databases and source to be used.
  Returntype : none
  Exceptions : will die if species not known or an error occurs while
             : trying to write to files.
  Caller     : general
 
Code:
click to view

◆ dump_xref()

public XrefMapper::SubmitMapper::dump_xref ( )
  Arg[1]: xref object which holds info on method and files.
  Description: Dumps the Xref data as fasta file(s)
  Returntype : none
  Exceptions : none
  Caller     : dump_seqs
 

/**

Undocumented method

Code:
click to view

◆ fetch_alt_allele_list()

public XrefMapper::SubmitMapper::fetch_alt_allele_list ( )

Undocumented method

Code:
click to view

◆ fetch_and_dump_seq_via_genes()

public XrefMapper::SubmitMapper::fetch_and_dump_seq_via_genes ( )

Undocumented method

Code:
click to view

◆ fetch_and_dump_seq_via_toplevel()

public XrefMapper::SubmitMapper::fetch_and_dump_seq_via_toplevel ( )

Undocumented method

Code:
click to view

◆ fix_mappings()

public void XrefMapper::SubmitMapper::fix_mappings ( )
  Example    :
none
  Description: submit mapping jobs to LSF for those that had problems, and wait for them to finish.
  Returntype : none
  Exceptions : none
  Caller     : general
 
Code:
click to view

◆ get_stored_methods()

public Arrayref XrefMapper::SubmitMapper::get_stored_methods ( )
  Description: Retrieves exonerate methods stored in the source_mapping_method table in the xref database
  Returntype : arrayref
  Exceptions : none
  Caller     : no_dump_xref
 
Code:
click to view

◆ jobcount()

public Scalar XrefMapper::SubmitMapper::jobcount ( )
  Arg [1]    : (optional)
  Example    :
$mapper->jobcount(1004);
  Description: Getter / Setter for number of jobs submitted.
  Returntype : scalar
  Exceptions : none
 
Code:
click to view

◆ mapper()

public XrefMapper::SubmitMapper::mapper ( )

Undocumented method

Code:
click to view

◆ method()

public XrefMapper::SubmitMapper::method ( )

Undocumented method

Code:
click to view

◆ new()

public XrefMapper::SubmitMapper::new ( )

Undocumented method

Code:
click to view

◆ no_dump_xref()

public XrefMapper::SubmitMapper::no_dump_xref ( )

Undocumented method

Code:
click to view

◆ nofarm()

public XrefMapper::SubmitMapper::nofarm ( )

Undocumented method

Code:
click to view

◆ remove_all_old_output_files()

public XrefMapper::SubmitMapper::remove_all_old_output_files ( )

Undocumented method

Code:
click to view

◆ run_mapping()

public void XrefMapper::SubmitMapper::run_mapping ( )
  Arg[1]     : List of lists of (method, query, target)
  Arg[2]     :
  Example    :
none
  Description: Create and submit mapping jobs to LSF, and wait for them to finish.
  Returntype : none
  Exceptions : none
  Caller     : general
 
Code:
click to view

◆ set_methods()

public String XrefMapper::SubmitMapper::set_methods ( )
  Description: Specifies the default exonerate method and non default methods which should be used for 
               one or more sources.
               Returns a string containing the default method and a hash refrence.
               The hash key is an exonerate method, the corresponding value is an array of source names
               whose xrefs are to be mapped using the exonerate method in the hash key.
               Multiple sources can be matched but only those with xrefs in the primary_xref table
               which holds sequence data are considered. If a particular source is not found, a warning 
               will be written out by the caller.
               This method can be overriden in species.pm
  Returntype : string, hash of arrays
  Example    :
my ($default_method, $override_method_for_source) = $self->set_methods();
  Exceptions : none
  Caller     : dump_xref
 
Code:
click to view

◆ submit_depend_job()

public void XrefMapper::SubmitMapper::submit_depend_job ( )
  Arg[1]     : List of job names.
  Arg[2]     :
  Example    :
none
  Description: Submit an LSF job that waits for other jobs to finish.
  Returntype : none
  Exceptions : none
  Caller     : general
 
Code:
click to view

The documentation for this class was generated from the following file:
XrefMapper::SubmitMapper::dump_seqs
public void dump_seqs()
XrefMapper::SubmitMapper::no_dump_xref
public no_dump_xref()
XrefMapper::SubmitMapper::dump_ensembl
public void dump_ensembl()
XrefMapper::SubmitMapper::fetch_and_dump_seq_via_toplevel
public fetch_and_dump_seq_via_toplevel()
Bio::EnsEMBL::DBSQL::DBAdaptor
Definition: DBAdaptor.pm:40
XrefMapper::SubmitMapper::check_err
public check_err()
XrefMapper::SubmitMapper::submit_depend_job
public void submit_depend_job()
XrefMapper::SubmitMapper::get_stored_methods
public Arrayref get_stored_methods()
XrefMapper::SubmitMapper::fetch_alt_allele_list
public fetch_alt_allele_list()
XrefMapper::SubmitMapper::dump_xref
public dump_xref()
XrefMapper::SubmitMapper::run_mapping
public void run_mapping()
XrefMapper::SubmitMapper::remove_all_old_output_files
public remove_all_old_output_files()
XrefMapper::SubmitMapper::fix_mappings
public void fix_mappings()
XrefMapper::SubmitMapper::set_methods
public String set_methods()
XrefMapper::SubmitMapper::jobcount
public Scalar jobcount()
XrefMapper::SubmitMapper::nofarm
public nofarm()
XrefMapper::SubmitMapper::mapper
public mapper()
XrefMapper::SubmitMapper::build_list_and_map
public void build_list_and_map()
XrefMapper::SubmitMapper::method
public method()
XrefMapper::SubmitMapper::fetch_and_dump_seq_via_genes
public fetch_and_dump_seq_via_genes()