src/jalview/ext/ensembl/EnsemblGene.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.ext.ensembl;
  22
  23 import jalview.api.FeatureColourI;
  24 import jalview.api.FeatureSettingsModelI;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.Sequence;
  27 import jalview.datamodel.SequenceFeature;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.io.gff.SequenceOntologyFactory;
  30 import jalview.io.gff.SequenceOntologyI;
  31 import jalview.schemes.FeatureColour;
  32 import jalview.schemes.FeatureSettingsAdapter;
  33 import jalview.util.MapList;
  34
  35 import java.awt.Color;
  36 import java.io.UnsupportedEncodingException;
  37 import java.net.URLDecoder;
  38 import java.util.ArrayList;
  39 import java.util.Arrays;
  40 import java.util.List;
  41
  42 import com.stevesoft.pat.Regex;
  43
  44 /**
  45  * A class that fetches genomic sequence and all transcripts for an Ensembl gene
  46  *
  47  * @author gmcarstairs
  48  */
  49 public class EnsemblGene extends EnsemblSeqProxy
  50 {
  51   private static final String GENE_PREFIX = "gene:";
  52
  53   /*
  54    * accepts anything as we will attempt lookup of gene or
  55    * transcript id or gene name
  56    */
  57   private static final Regex ACCESSION_REGEX = new Regex(".*");
  58
  59   private static final EnsemblFeatureType[] FEATURES_TO_FETCH = {
  60       EnsemblFeatureType.gene, EnsemblFeatureType.transcript,
  61       EnsemblFeatureType.exon, EnsemblFeatureType.cds,
  62       EnsemblFeatureType.variation };
  63
  64   /**
  65    * Default constructor (to use rest.ensembl.org)
  66    */
  67   public EnsemblGene()
  68   {
  69     super();
  70   }
  71
  72   /**
  73    * Constructor given the target domain to fetch data from
  74    *
  75    * @param d
  76    */
  77   public EnsemblGene(String d)
  78   {
  79     super(d);
  80   }
  81
  82   @Override
  83   public String getDbName()
  84   {
  85     return "ENSEMBL";
  86   }
  87
  88   @Override
  89   protected EnsemblFeatureType[] getFeaturesToFetch()
  90   {
  91     return FEATURES_TO_FETCH;
  92   }
  93
  94   @Override
  95   protected EnsemblSeqType getSourceEnsemblType()
  96   {
  97     return EnsemblSeqType.GENOMIC;
  98   }
  99
 100   /**
 101    * Returns an alignment containing the gene(s) for the given gene or
 102    * transcript identifier, or external identifier (e.g. Uniprot id). If given a
 103    * gene name or external identifier, returns any related gene sequences found
 104    * for model organisms. If only a single gene is queried for, then its
 105    * transcripts are also retrieved and added to the alignment. <br>
 106    * Method:
 107    * <ul>
 108    * <li>resolves a transcript identifier by looking up its parent gene id</li>
 109    * <li>resolves an external identifier by looking up xref-ed gene ids</li>
 110    * <li>fetches the gene sequence</li>
 111    * <li>fetches features on the sequence</li>
 112    * <li>identifies "transcript" features whose Parent is the requested gene</li>
 113    * <li>fetches the transcript sequence for each transcript</li>
 114    * <li>makes a mapping from the gene to each transcript</li>
 115    * <li>copies features from gene to transcript sequences</li>
 116    * <li>fetches the protein sequence for each transcript, maps and saves it as
 117    * a cross-reference</li>
 118    * <li>aligns each transcript against the gene sequence based on the position
 119    * mappings</li>
 120    * </ul>
 121    *
 122    * @param query
 123    *          a single gene or transcript identifier or gene name
 124    * @return an alignment containing a gene, and possibly transcripts, or null
 125    */
 126   @Override
 127   public AlignmentI getSequenceRecords(String query) throws Exception
 128   {
 129     /*
 130      * convert to a non-duplicated list of gene identifiers
 131      */
 132     List<String> geneIds = getGeneIds(query);
 133
 134     AlignmentI al = null;
 135     for (String geneId : geneIds)
 136     {
 137       /*
 138        * fetch the gene sequence(s) with features and xrefs
 139        */
 140       AlignmentI geneAlignment = super.getSequenceRecords(geneId);
 141       if (geneAlignment == null)
 142       {
 143         continue;
 144       }
 145       if (geneAlignment.getHeight() == 1)
 146       {
 147         getTranscripts(geneAlignment, geneId);
 148       }
 149       if (al == null)
 150       {
 151         al = geneAlignment;
 152       }
 153       else
 154       {
 155         al.append(geneAlignment);
 156       }
 157     }
 158     return al;
 159   }
 160
 161   /**
 162    * Converts a query, which may contain one or more gene or transcript
 163    * identifiers, into a non-redundant list of gene identifiers.
 164    *
 165    * @param accessions
 166    * @return
 167    */
 168   List<String> getGeneIds(String accessions)
 169   {
 170     List<String> geneIds = new ArrayList<String>();
 171
 172     for (String acc : accessions.split(getAccessionSeparator()))
 173     {
 174       if (isGeneIdentifier(acc))
 175       {
 176         if (!geneIds.contains(acc))
 177         {
 178           geneIds.add(acc);
 179         }
 180       }
 181
 182       /*
 183        * if given a transcript id, look up its gene parent
 184        */
 185       else if (isTranscriptIdentifier(acc))
 186       {
 187         String geneId = new EnsemblLookup(getDomain()).getParent(acc);
 188         if (geneId != null && !geneIds.contains(geneId))
 189         {
 190           geneIds.add(geneId);
 191         }
 192       }
 193       else if (isProteinIdentifier(acc))
 194       {
 195         String tscriptId = new EnsemblLookup(getDomain()).getParent(acc);
 196         if (tscriptId != null)
 197         {
 198           String geneId = new EnsemblLookup(getDomain())
 199                   .getParent(tscriptId);
 200
 201           if (geneId != null && !geneIds.contains(geneId))
 202           {
 203             geneIds.add(geneId);
 204           }
 205         }
 206       }
 207       /*
 208        * if given a gene or other external name, lookup and fetch
 209        * the corresponding gene for all model organisms
 210        */
 211       else
 212       {
 213         List<String> ids = new EnsemblSymbol(getDomain(), getDbSource(),
 214                 getDbVersion()).getIds(acc);
 215         for (String geneId : ids)
 216         {
 217           if (!geneIds.contains(geneId))
 218           {
 219             geneIds.add(geneId);
 220           }
 221         }
 222       }
 223     }
 224     return geneIds;
 225   }
 226
 227   /**
 228    * Attempts to get Ensembl stable identifiers for model organisms for a gene
 229    * name by calling the xrefs symbol REST service to resolve the gene name.
 230    *
 231    * @param query
 232    * @return
 233    */
 234   protected String getGeneIdentifiersForName(String query)
 235   {
 236     List<String> ids = new EnsemblSymbol(getDomain(), getDbSource(),
 237             getDbVersion()).getIds(query);
 238     if (ids != null)
 239     {
 240       for (String id : ids)
 241       {
 242         if (isGeneIdentifier(id))
 243         {
 244           return id;
 245         }
 246       }
 247     }
 248     return null;
 249   }
 250
 251   /**
 252    * Constructs all transcripts for the gene, as identified by "transcript"
 253    * features whose Parent is the requested gene. The coding transcript
 254    * sequences (i.e. with introns omitted) are added to the alignment.
 255    *
 256    * @param al
 257    * @param accId
 258    * @throws Exception
 259    */
 260   protected void getTranscripts(AlignmentI al, String accId)
 261           throws Exception
 262   {
 263     SequenceI gene = al.getSequenceAt(0);
 264     List<SequenceFeature> transcriptFeatures = getTranscriptFeatures(accId,
 265             gene);
 266
 267     for (SequenceFeature transcriptFeature : transcriptFeatures)
 268     {
 269       makeTranscript(transcriptFeature, al, gene);
 270     }
 271
 272     clearGeneFeatures(gene);
 273   }
 274
 275   /**
 276    * Remove unwanted features (transcript, exon, CDS) from the gene sequence
 277    * after we have used them to derive transcripts and transfer features
 278    *
 279    * @param gene
 280    */
 281   protected void clearGeneFeatures(SequenceI gene)
 282   {
 283     SequenceFeature[] sfs = gene.getSequenceFeatures();
 284     if (sfs != null)
 285     {
 286       SequenceOntologyI so = SequenceOntologyFactory.getInstance();
 287       List<SequenceFeature> filtered = new ArrayList<SequenceFeature>();
 288       for (SequenceFeature sf : sfs)
 289       {
 290         String type = sf.getType();
 291         if (!isTranscript(type) && !so.isA(type, SequenceOntologyI.EXON)
 292                 && !so.isA(type, SequenceOntologyI.CDS))
 293         {
 294           filtered.add(sf);
 295         }
 296       }
 297       gene.setSequenceFeatures(filtered
 298               .toArray(new SequenceFeature[filtered.size()]));
 299     }
 300   }
 301
 302   /**
 303    * Constructs a spliced transcript sequence by finding 'exon' features for the
 304    * given id (or failing that 'CDS'). Copies features on to the new sequence.
 305    * 'Aligns' the new sequence against the gene sequence by padding with gaps,
 306    * and adds it to the alignment.
 307    *
 308    * @param transcriptFeature
 309    * @param al
 310    *          the alignment to which to add the new sequence
 311    * @param gene
 312    *          the parent gene sequence, with features
 313    * @return
 314    */
 315   SequenceI makeTranscript(SequenceFeature transcriptFeature,
 316           AlignmentI al, SequenceI gene)
 317   {
 318     String accId = getTranscriptId(transcriptFeature);
 319     if (accId == null)
 320     {
 321       return null;
 322     }
 323
 324     /*
 325      * NB we are mapping from gene sequence (not genome), so do not
 326      * need to check for reverse strand (gene and transcript sequences
 327      * are in forward sense)
 328      */
 329
 330     /*
 331      * make a gene-length sequence filled with gaps
 332      * we will fill in the bases for transcript regions
 333      */
 334     char[] seqChars = new char[gene.getLength()];
 335     Arrays.fill(seqChars, al.getGapCharacter());
 336
 337     /*
 338      * look for exon features of the transcript, failing that for CDS
 339      * (for example ENSG00000124610 has 1 CDS but no exon features)
 340      */
 341     String parentId = "transcript:" + accId;
 342     List<SequenceFeature> splices = findFeatures(gene,
 343             SequenceOntologyI.EXON, parentId);
 344     if (splices.isEmpty())
 345     {
 346       splices = findFeatures(gene, SequenceOntologyI.CDS, parentId);
 347     }
 348
 349     int transcriptLength = 0;
 350     final char[] geneChars = gene.getSequence();
 351     int offset = gene.getStart(); // to convert to 0-based positions
 352     List<int[]> mappedFrom = new ArrayList<int[]>();
 353
 354     for (SequenceFeature sf : splices)
 355     {
 356       int start = sf.getBegin() - offset;
 357       int end = sf.getEnd() - offset;
 358       int spliceLength = end - start + 1;
 359       System.arraycopy(geneChars, start, seqChars, start, spliceLength);
 360       transcriptLength += spliceLength;
 361       mappedFrom.add(new int[] { sf.getBegin(), sf.getEnd() });
 362     }
 363
 364     Sequence transcript = new Sequence(accId, seqChars, 1, transcriptLength);
 365
 366     /*
 367      * Ensembl has gene name as transcript Name
 368      * EnsemblGenomes doesn't, but has a url-encoded description field
 369      */
 370     String description = (String) transcriptFeature.getValue(NAME);
 371     if (description == null)
 372     {
 373       description = (String) transcriptFeature.getValue(DESCRIPTION);
 374     }
 375     if (description != null)
 376     {
 377       try
 378       {
 379         transcript.setDescription(URLDecoder.decode(description, "UTF-8"));
 380       } catch (UnsupportedEncodingException e)
 381       {
 382         e.printStackTrace(); // as if
 383       }
 384     }
 385     transcript.createDatasetSequence();
 386
 387     al.addSequence(transcript);
 388
 389     /*
 390      * transfer features to the new sequence; we use EnsemblCdna to do this,
 391      * to filter out unwanted features types (see method retainFeature)
 392      */
 393     List<int[]> mapTo = new ArrayList<int[]>();
 394     mapTo.add(new int[] { 1, transcriptLength });
 395     MapList mapping = new MapList(mappedFrom, mapTo, 1, 1);
 396     EnsemblCdna cdna = new EnsemblCdna(getDomain());
 397     cdna.transferFeatures(gene.getSequenceFeatures(),
 398             transcript.getDatasetSequence(), mapping, parentId);
 399
 400     /*
 401      * fetch and save cross-references
 402      */
 403     cdna.getCrossReferences(transcript);
 404
 405     /*
 406      * and finally fetch the protein product and save as a cross-reference
 407      */
 408     cdna.addProteinProduct(transcript);
 409
 410     return transcript;
 411   }
 412
 413   /**
 414    * Returns the 'transcript_id' property of the sequence feature (or null)
 415    *
 416    * @param feature
 417    * @return
 418    */
 419   protected String getTranscriptId(SequenceFeature feature)
 420   {
 421     return (String) feature.getValue("transcript_id");
 422   }
 423
 424   /**
 425    * Returns a list of the transcript features on the sequence whose Parent is
 426    * the gene for the accession id.
 427    *
 428    * @param accId
 429    * @param geneSequence
 430    * @return
 431    */
 432   protected List<SequenceFeature> getTranscriptFeatures(String accId,
 433           SequenceI geneSequence)
 434   {
 435     List<SequenceFeature> transcriptFeatures = new ArrayList<SequenceFeature>();
 436
 437     String parentIdentifier = GENE_PREFIX + accId;
 438     SequenceFeature[] sfs = geneSequence.getSequenceFeatures();
 439
 440     if (sfs != null)
 441     {
 442       for (SequenceFeature sf : sfs)
 443       {
 444         if (isTranscript(sf.getType()))
 445         {
 446           String parent = (String) sf.getValue(PARENT);
 447           if (parentIdentifier.equals(parent))
 448           {
 449             transcriptFeatures.add(sf);
 450           }
 451         }
 452       }
 453     }
 454
 455     return transcriptFeatures;
 456   }
 457
 458   @Override
 459   public String getDescription()
 460   {
 461     return "Fetches all transcripts and variant features for a gene or transcript";
 462   }
 463
 464   /**
 465    * Default test query is a gene id (can also enter a transcript id)
 466    */
 467   @Override
 468   public String getTestQuery()
 469   {
 470     return "ENSG00000157764"; // BRAF, 5 transcripts, reverse strand
 471     // ENSG00000090266 // NDUFB2, 15 transcripts, forward strand
 472     // ENSG00000101812 // H2BFM histone, 3 transcripts, forward strand
 473     // ENSG00000123569 // H2BFWT histone, 2 transcripts, reverse strand
 474   }
 475
 476   /**
 477    * Answers true for a feature of type 'gene' (or a sub-type of gene in the
 478    * Sequence Ontology), whose ID is the accession we are retrieving
 479    */
 480   @Override
 481   protected boolean identifiesSequence(SequenceFeature sf, String accId)
 482   {
 483     if (SequenceOntologyFactory.getInstance().isA(sf.getType(),
 484             SequenceOntologyI.GENE))
 485     {
 486       String id = (String) sf.getValue(ID);
 487       if ((GENE_PREFIX + accId).equals(id))
 488       {
 489         return true;
 490       }
 491     }
 492     return false;
 493   }
 494
 495   /**
 496    * Answers true unless feature type is 'gene', or 'transcript' with a parent
 497    * which is a different gene. We need the gene features to identify the range,
 498    * but it is redundant information on the gene sequence. Checking the parent
 499    * allows us to drop transcript features which belong to different
 500    * (overlapping) genes.
 501    */
 502   @Override
 503   protected boolean retainFeature(SequenceFeature sf, String accessionId)
 504   {
 505     SequenceOntologyI so = SequenceOntologyFactory.getInstance();
 506     String type = sf.getType();
 507     if (so.isA(type, SequenceOntologyI.GENE))
 508     {
 509       return false;
 510     }
 511     if (isTranscript(type))
 512     {
 513       String parent = (String) sf.getValue(PARENT);
 514       if (!(GENE_PREFIX + accessionId).equals(parent))
 515       {
 516         return false;
 517       }
 518     }
 519     return true;
 520   }
 521
 522   /**
 523    * Answers false. This allows an optimisation - a single 'gene' feature is all
 524    * that is needed to identify the positions of the gene on the genomic
 525    * sequence.
 526    */
 527   @Override
 528   protected boolean isSpliceable()
 529   {
 530     return false;
 531   }
 532
 533   /**
 534    * Override to do nothing as Ensembl doesn't return a protein sequence for a
 535    * gene identifier
 536    */
 537   @Override
 538   protected void addProteinProduct(SequenceI querySeq)
 539   {
 540   }
 541
 542   @Override
 543   public Regex getAccessionValidator()
 544   {
 545     return ACCESSION_REGEX;
 546   }
 547
 548   /**
 549    * Returns a descriptor for suitable feature display settings with
 550    * <ul>
 551    * <li>only exon or sequence_variant features (or their subtypes in the
 552    * Sequence Ontology) visible</li>
 553    * <li>variant features coloured red</li>
 554    * <li>exon features coloured by label (exon name)</li>
 555    * <li>variants displayed above (on top of) exons</li>
 556    * </ul>
 557    */
 558   @Override
 559   public FeatureSettingsModelI getFeatureColourScheme()
 560   {
 561     return new FeatureSettingsAdapter()
 562     {
 563       SequenceOntologyI so = SequenceOntologyFactory.getInstance();
 564
 565       @Override
 566       public boolean isFeatureDisplayed(String type)
 567       {
 568         return (so.isA(type, SequenceOntologyI.EXON) || so.isA(type,
 569                 SequenceOntologyI.SEQUENCE_VARIANT));
 570       }
 571
 572       @Override
 573       public FeatureColourI getFeatureColour(String type)
 574       {
 575         if (so.isA(type, SequenceOntologyI.EXON))
 576         {
 577           return new FeatureColour()
 578           {
 579             @Override
 580             public boolean isColourByLabel()
 581             {
 582               return true;
 583             }
 584           };
 585         }
 586         if (so.isA(type, SequenceOntologyI.SEQUENCE_VARIANT))
 587         {
 588           return new FeatureColour()
 589           {
 590
 591             @Override
 592             public Color getColour()
 593             {
 594               return Color.RED;
 595             }
 596           };
 597         }
 598         return null;
 599       }
 600
 601       /**
 602        * order to render sequence_variant after exon after the rest
 603        */
 604       @Override
 605       public int compare(String feature1, String feature2)
 606       {
 607         if (so.isA(feature1, SequenceOntologyI.SEQUENCE_VARIANT))
 608         {
 609           return +1;
 610         }
 611         if (so.isA(feature2, SequenceOntologyI.SEQUENCE_VARIANT))
 612         {
 613           return -1;
 614         }
 615         if (so.isA(feature1, SequenceOntologyI.EXON))
 616         {
 617           return +1;
 618         }
 619         if (so.isA(feature2, SequenceOntologyI.EXON))
 620         {
 621           return -1;
 622         }
 623         return 0;
 624       }
 625     };
 626   }
 627
 628 }