Bio::EnsEMBL::Utils::TranscriptSelector Class Reference

Public Member Functions
public Bio::EnsEMBL::Utils::TranscriptSelector	new ()
public Bio::EnsEMBL::Transcript	select_canonical_transcript_for_Gene ()
public Listref	encode_transcript ()
public Listref	sort_into_canonical_order ()
public Boolean	check_Ens_trans_against_CCDS ()

Detailed Description

Synopsis

my $selector = Bio::EnsEMBL::Utils::TranscriptSelector->new($ccds_dba);
my $canonical_transcript = $selector->select_canonical_transcript_for_Gene($gene);

Description

  The decision process for choosing a canonical transcript of a given Gene is
  an involved process. This package converts transcript attributes into
  numeric values, sorts the values and returns the favourite transcript.
  
  The canonical order of precedence is as follows:
    longest translation of transcript present in CCDS that is reference sequence
    longest translation of protein-coding transcript
    longest translation of transcript marked nonsense-mediated-decay
    longest translation of any other transcript (premature stop codon translations have an effective length of 0)
    longest non-coding transcript
    first stable ID in alphabetical order
    
  The last condition is to give consistent behaviour when everything is else is equal.
  It selects the "older" stable ID, thus preventing new IDs supplanting old ones that
  remain correct.

Definition at line 30 of file TranscriptSelector.pm.

Member Function Documentation

check_Ens_trans_against_CCDS()

public Boolean Bio::EnsEMBL::Utils::TranscriptSelector::check_Ens_trans_against_CCDS

(

)

  Arg 1      : Transcript 
  Description: Attempts to find a matching transcript in CCDS by comparing Exon
               composition. Returns true if one is found, or silently ends. 
  Returntype : Boolean
  Caller     : encode_transcript
 

Code:

encode_transcript()

public Listref Bio::EnsEMBL::Utils::TranscriptSelector::encode_transcript

(

)

 Arg 1      : Transcript
 Description: Converts a transcript into a list of encoded values for sorting
              Priorities are defined immediately above
              Unimportant biotypes and sources are classed as 'other'
 Returntype : Listref of encoded attributes
 

Code:

new()

public Bio::EnsEMBL::Utils::TranscriptSelector Bio::EnsEMBL::Utils::TranscriptSelector::new

(

)

  Arg [1]    : Optional - CCDS database adaptor - needed for species with CCDS only
  Arg [2]    : Optional - Boolean verbose flag. Turn on to fill your logs
  Description: Constructor
  Returntype : Bio::EnsEMBL::Utils::TranscriptSelector

Code:

select_canonical_transcript_for_Gene()

public Bio::EnsEMBL::Transcript Bio::EnsEMBL::Utils::TranscriptSelector::select_canonical_transcript_for_Gene

(

)

 Arg 1      : Bio::EnsEMBL::Gene 
 Example    :

$canonical_transcript = $selector->select_canonical_transcript_for_Gene

 Description: Sorts the Transcripts of this Gene into order of suitability,
              and returns the favourite Transcript.
 Returntype : Bio::EnsEMBL::Transcript
 Exceptions :

Code:

sort_into_canonical_order()

public Listref Bio::EnsEMBL::Utils::TranscriptSelector::sort_into_canonical_order

(

)

  Arg 1      : 2D array reference of numerically encoded values
                        0              1        2         3             4                  5               6
              ( [transcript dbID, translates, source , biotype, translation length, transcript length, stable ID],
                ...
              ) 
  Description: see Schwartzian transform for method in the following madness:
               sort the 6-column array by the last 5 columns, then map the first elements
               into a list of dbIDs, now in canonical order. 
  Returntype : Listref of ensembl dbIDs
  Caller     : select_canonical_transcript_for_Gene
 

Code:

---

The documentation for this class was generated from the following file:

• ensembl/modules/Bio/EnsEMBL/Utils/TranscriptSelector.pm