src/jalview/io/vcf/VCFLoader.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.io.vcf;
  22
  23 import jalview.analysis.Dna;
  24 import jalview.api.AlignViewControllerGuiI;
  25 import jalview.bin.Cache;
  26 import jalview.datamodel.DBRefEntry;
  27 import jalview.datamodel.GeneLociI;
  28 import jalview.datamodel.Mapping;
  29 import jalview.datamodel.SequenceFeature;
  30 import jalview.datamodel.SequenceI;
  31 import jalview.datamodel.features.FeatureAttributeType;
  32 import jalview.datamodel.features.FeatureSource;
  33 import jalview.datamodel.features.FeatureSources;
  34 import jalview.ext.ensembl.EnsemblMap;
  35 import jalview.ext.htsjdk.HtsContigDb;
  36 import jalview.ext.htsjdk.VCFReader;
  37 import jalview.io.gff.Gff3Helper;
  38 import jalview.io.gff.SequenceOntologyI;
  39 import jalview.util.MapList;
  40 import jalview.util.MappingUtils;
  41 import jalview.util.MessageManager;
  42 import jalview.util.StringUtils;
  43
  44 import java.io.File;
  45 import java.io.IOException;
  46 import java.util.ArrayList;
  47 import java.util.HashMap;
  48 import java.util.HashSet;
  49 import java.util.Iterator;
  50 import java.util.List;
  51 import java.util.Locale;
  52 import java.util.Map;
  53 import java.util.Map.Entry;
  54 import java.util.Set;
  55 import java.util.regex.Pattern;
  56 import java.util.regex.PatternSyntaxException;
  57
  58 import htsjdk.samtools.SAMException;
  59 import htsjdk.samtools.SAMSequenceDictionary;
  60 import htsjdk.samtools.SAMSequenceRecord;
  61 import htsjdk.samtools.util.CloseableIterator;
  62 import htsjdk.tribble.TribbleException;
  63 import htsjdk.variant.variantcontext.Allele;
  64 import htsjdk.variant.variantcontext.VariantContext;
  65 import htsjdk.variant.vcf.VCFConstants;
  66 import htsjdk.variant.vcf.VCFHeader;
  67 import htsjdk.variant.vcf.VCFHeaderLine;
  68 import htsjdk.variant.vcf.VCFHeaderLineCount;
  69 import htsjdk.variant.vcf.VCFHeaderLineType;
  70 import htsjdk.variant.vcf.VCFInfoHeaderLine;
  71
  72 /**
  73  * A class to read VCF data (using the htsjdk) and add variants as sequence
  74  * features on dna and any related protein product sequences
  75  *
  76  * @author gmcarstairs
  77  */
  78 public class VCFLoader
  79 {
  80   private static final String VCF_ENCODABLE = ":;=%,";
  81
  82   /*
  83    * Jalview feature attributes for VCF fixed column data
  84    */
  85   private static final String VCF_POS = "POS";
  86
  87   private static final String VCF_ID = "ID";
  88
  89   private static final String VCF_QUAL = "QUAL";
  90
  91   private static final String VCF_FILTER = "FILTER";
  92
  93   private static final String NO_VALUE = VCFConstants.MISSING_VALUE_v4; // '.'
  94
  95   private static final String DEFAULT_SPECIES = "homo_sapiens";
  96
  97   /**
  98    * A class to model the mapping from sequence to VCF coordinates. Cases include
  99    * <ul>
 100    * <li>a direct 1:1 mapping where the sequence is one of the VCF contigs</li>
 101    * <li>a mapping of sequence to chromosomal coordinates, where sequence and VCF
 102    * use the same reference assembly</li>
 103    * <li>a modified mapping of sequence to chromosomal coordinates, where sequence
 104    * and VCF use different reference assembles</li>
 105    * </ul>
 106    */
 107   class VCFMap
 108   {
 109     final String chromosome;
 110
 111     final MapList map;
 112
 113     VCFMap(String chr, MapList m)
 114     {
 115       chromosome = chr;
 116       map = m;
 117     }
 118
 119     @Override
 120     public String toString()
 121     {
 122       return chromosome + ":" + map.toString();
 123     }
 124   }
 125
 126   /*
 127    * Lookup keys, and default values, for Preference entries that describe
 128    * patterns for VCF and VEP fields to capture
 129    */
 130   private static final String VEP_FIELDS_PREF = "VEP_FIELDS";
 131
 132   private static final String VCF_FIELDS_PREF = "VCF_FIELDS";
 133
 134   private static final String DEFAULT_VCF_FIELDS = ".*";
 135
 136   private static final String DEFAULT_VEP_FIELDS = ".*";// "Allele,Consequence,IMPACT,SWISSPROT,SIFT,PolyPhen,CLIN_SIG";
 137
 138   /*
 139    * Lookup keys, and default values, for Preference entries that give
 140    * mappings from tokens in the 'reference' header to species or assembly
 141    */
 142   private static final String VCF_ASSEMBLY = "VCF_ASSEMBLY";
 143
 144   private static final String DEFAULT_VCF_ASSEMBLY = "assembly19=GRCh37,hs37=GRCh37,grch37=GRCh37,grch38=GRCh38";
 145
 146   private static final String VCF_SPECIES = "VCF_SPECIES"; // default is human
 147
 148   private static final String DEFAULT_REFERENCE = "grch37"; // fallback default is human GRCh37
 149
 150   /*
 151    * keys to fields of VEP CSQ consequence data
 152    * see https://www.ensembl.org/info/docs/tools/vep/vep_formats.html
 153    */
 154   private static final String CSQ_CONSEQUENCE_KEY = "Consequence";
 155   private static final String CSQ_ALLELE_KEY = "Allele";
 156   private static final String CSQ_ALLELE_NUM_KEY = "ALLELE_NUM"; // 0 (ref), 1...
 157   private static final String CSQ_FEATURE_KEY = "Feature"; // Ensembl stable id
 158
 159   /*
 160    * default VCF INFO key for VEP consequence data
 161    * NB this can be overridden running VEP with --vcf_info_field
 162    * - we don't handle this case (require identifier to be CSQ)
 163    */
 164   private static final String CSQ_FIELD = "CSQ";
 165
 166   /*
 167    * separator for fields in consequence data is '|'
 168    */
 169   private static final String PIPE_REGEX = "\\|";
 170
 171   /*
 172    * delimiter that separates multiple consequence data blocks
 173    */
 174   private static final String COMMA = ",";
 175
 176   /*
 177    * the feature group assigned to a VCF variant in Jalview
 178    */
 179   private static final String FEATURE_GROUP_VCF = "VCF";
 180
 181   /*
 182    * internal delimiter used to build keys for assemblyMappings
 183    *
 184    */
 185   private static final String EXCL = "!";
 186
 187   /*
 188    * the VCF file we are processing
 189    */
 190   protected String vcfFilePath;
 191
 192   /*
 193    * mappings between VCF and sequence reference assembly regions, as
 194    * key = "species!chromosome!fromAssembly!toAssembly
 195    * value = Map{fromRange, toRange}
 196    */
 197   private Map<String, Map<int[], int[]>> assemblyMappings;
 198
 199   private VCFReader reader;
 200
 201   /*
 202    * holds details of the VCF header lines (metadata)
 203    */
 204   private VCFHeader header;
 205
 206   /*
 207    * species (as a valid Ensembl term) the VCF is for
 208    */
 209   private String vcfSpecies;
 210
 211   /*
 212    * genome assembly version (as a valid Ensembl identifier) the VCF is for
 213    */
 214   private String vcfAssembly;
 215
 216   /*
 217    * a Dictionary of contigs (if present) referenced in the VCF file
 218    */
 219   private SAMSequenceDictionary dictionary;
 220
 221   /*
 222    * the position (0...) of field in each block of
 223    * CSQ (consequence) data (if declared in the VCF INFO header for CSQ)
 224    * see http://www.ensembl.org/info/docs/tools/vep/vep_formats.html
 225    */
 226   private int csqConsequenceFieldIndex = -1;
 227   private int csqAlleleFieldIndex = -1;
 228   private int csqAlleleNumberFieldIndex = -1;
 229   private int csqFeatureFieldIndex = -1;
 230
 231   // todo the same fields for SnpEff ANN data if wanted
 232   // see http://snpeff.sourceforge.net/SnpEff_manual.html#input
 233
 234   /*
 235    * a unique identifier under which to save metadata about feature
 236    * attributes (selected INFO field data)
 237    */
 238   private String sourceId;
 239
 240   /*
 241    * The INFO IDs of data that is both present in the VCF file, and
 242    * also matched by any filters for data of interest
 243    */
 244   List<String> vcfFieldsOfInterest;
 245
 246   /*
 247    * The field offsets and identifiers for VEP (CSQ) data that is both present
 248    * in the VCF file, and also matched by any filters for data of interest
 249    * for example 0 -> Allele, 1 -> Consequence, ..., 36 -> SIFT, ...
 250    */
 251   Map<Integer, String> vepFieldsOfInterest;
 252
 253   /*
 254    * key:value for which rejected data has been seen
 255    * (the error is logged only once for each combination)
 256    */
 257   private Set<String> badData;
 258
 259   /**
 260    * Constructor given a VCF file
 261    *
 262    * @param alignment
 263    */
 264   public VCFLoader(String vcfFile)
 265   {
 266     try
 267     {
 268       initialise(vcfFile);
 269     } catch (IOException e)
 270     {
 271       System.err.println("Error opening VCF file: " + e.getMessage());
 272     }
 273
 274     // map of species!chromosome!fromAssembly!toAssembly to {fromRange, toRange}
 275     assemblyMappings = new HashMap<>();
 276   }
 277
 278   /**
 279    * Starts a new thread to query and load VCF variant data on to the given
 280    * sequences
 281    * <p>
 282    * This method is not thread safe - concurrent threads should use separate
 283    * instances of this class.
 284    *
 285    * @param seqs
 286    * @param gui
 287    */
 288   public void loadVCF(SequenceI[] seqs, final AlignViewControllerGuiI gui)
 289   {
 290     if (gui != null)
 291     {
 292       gui.setStatus(MessageManager.getString("label.searching_vcf"));
 293     }
 294
 295     new Thread()
 296     {
 297       @Override
 298       public void run()
 299       {
 300         VCFLoader.this.doLoad(seqs, gui);
 301       }
 302     }.start();
 303   }
 304
 305   /**
 306    * Reads the specified contig sequence and adds its VCF variants to it
 307    *
 308    * @param contig
 309    *          the id of a single sequence (contig) to load
 310    * @return
 311    */
 312   public SequenceI loadVCFContig(String contig)
 313   {
 314     VCFHeaderLine headerLine = header.getOtherHeaderLine(VCFHeader.REFERENCE_KEY);
 315     if (headerLine == null)
 316     {
 317       Cache.log.error("VCF reference header not found");
 318       return null;
 319     }
 320     String ref = headerLine.getValue();
 321     if (ref.startsWith("file://"))
 322     {
 323       ref = ref.substring(7);
 324     }
 325     setSpeciesAndAssembly(ref);
 326
 327     SequenceI seq = null;
 328     File dbFile = new File(ref);
 329
 330     if (dbFile.exists())
 331     {
 332       HtsContigDb db = new HtsContigDb("", dbFile);
 333       seq = db.getSequenceProxy(contig);
 334       loadSequenceVCF(seq);
 335       db.close();
 336     }
 337     else
 338     {
 339       Cache.log.error("VCF reference not found: " + ref);
 340     }
 341
 342     return seq;
 343   }
 344
 345   /**
 346    * Loads VCF on to one or more sequences
 347    *
 348    * @param seqs
 349    * @param gui
 350    *          optional callback handler for messages
 351    */
 352   protected void doLoad(SequenceI[] seqs, AlignViewControllerGuiI gui)
 353   {
 354     try
 355     {
 356       VCFHeaderLine ref = header
 357               .getOtherHeaderLine(VCFHeader.REFERENCE_KEY);
 358       String reference = ref == null ? null : ref.getValue();
 359
 360       setSpeciesAndAssembly(reference);
 361
 362       int varCount = 0;
 363       int seqCount = 0;
 364
 365       /*
 366        * query for VCF overlapping each sequence in turn
 367        */
 368       for (SequenceI seq : seqs)
 369       {
 370         int added = loadSequenceVCF(seq);
 371         if (added > 0)
 372         {
 373           seqCount++;
 374           varCount += added;
 375           transferAddedFeatures(seq);
 376         }
 377       }
 378       if (gui != null)
 379       {
 380         String msg = MessageManager.formatMessage("label.added_vcf",
 381                 varCount, seqCount);
 382         gui.setStatus(msg);
 383         if (gui.getFeatureSettingsUI() != null)
 384         {
 385           gui.getFeatureSettingsUI().discoverAllFeatureData();
 386         }
 387       }
 388     } catch (Throwable e)
 389     {
 390       System.err.println("Error processing VCF: " + e.getMessage());
 391       e.printStackTrace();
 392       if (gui != null)
 393       {
 394         gui.setStatus("Error occurred - see console for details");
 395       }
 396     } finally
 397     {
 398       if (reader != null)
 399       {
 400         try
 401         {
 402           reader.close();
 403         } catch (IOException e)
 404         {
 405           // ignore
 406         }
 407       }
 408       header = null;
 409       dictionary = null;
 410     }
 411   }
 412
 413   /**
 414    * Attempts to determine and save the species and genome assembly version to
 415    * which the VCF data applies. This may be done by parsing the {@code reference}
 416    * header line, configured in a property file, or (potentially) confirmed
 417    * interactively by the user.
 418    * <p>
 419    * The saved values should be identifiers valid for Ensembl's REST service
 420    * {@code map} endpoint, so they can be used (if necessary) to retrieve the
 421    * mapping between VCF coordinates and sequence coordinates.
 422    *
 423    * @param reference
 424    * @see https://rest.ensembl.org/documentation/info/assembly_map
 425    * @see https://rest.ensembl.org/info/assembly/human?content-type=text/xml
 426    * @see https://rest.ensembl.org/info/species?content-type=text/xml
 427    */
 428   protected void setSpeciesAndAssembly(String reference)
 429   {
 430     if (reference == null)
 431     {
 432       Cache.log.error("No VCF ##reference found, defaulting to "
 433               + DEFAULT_REFERENCE + ":" + DEFAULT_SPECIES);
 434       reference = DEFAULT_REFERENCE; // default to GRCh37 if not specified
 435     }
 436     reference = reference.toLowerCase();
 437
 438     /*
 439      * for a non-human species, or other assembly identifier,
 440      * specify as a Jalview property file entry e.g.
 441      * VCF_ASSEMBLY = hs37=GRCh37,assembly19=GRCh37
 442      * VCF_SPECIES = c_elegans=celegans
 443      * to map a token in the reference header to a value
 444      */
 445     String prop = Cache.getDefault(VCF_ASSEMBLY, DEFAULT_VCF_ASSEMBLY);
 446     for (String token : prop.split(","))
 447     {
 448       String[] tokens = token.split("=");
 449       if (tokens.length == 2)
 450       {
 451         if (reference.contains(tokens[0].trim().toLowerCase()))
 452         {
 453           vcfAssembly = tokens[1].trim();
 454           break;
 455         }
 456       }
 457     }
 458
 459     vcfSpecies = DEFAULT_SPECIES;
 460     prop = Cache.getProperty(VCF_SPECIES);
 461     if (prop != null)
 462     {
 463       for (String token : prop.split(","))
 464       {
 465         String[] tokens = token.split("=");
 466         if (tokens.length == 2)
 467         {
 468           if (reference.contains(tokens[0].trim().toLowerCase()))
 469           {
 470             vcfSpecies = tokens[1].trim();
 471             break;
 472           }
 473         }
 474       }
 475     }
 476   }
 477
 478   /**
 479    * Opens the VCF file and parses header data
 480    *
 481    * @param filePath
 482    * @throws IOException
 483    */
 484   private void initialise(String filePath) throws IOException
 485   {
 486     vcfFilePath = filePath;
 487
 488     reader = new VCFReader(filePath);
 489
 490     header = reader.getFileHeader();
 491
 492     try
 493     {
 494       dictionary = header.getSequenceDictionary();
 495     } catch (SAMException e)
 496     {
 497       // ignore - thrown if any contig line lacks length info
 498     }
 499
 500     sourceId = filePath;
 501
 502     saveMetadata(sourceId);
 503
 504     /*
 505      * get offset of CSQ ALLELE_NUM and Feature if declared
 506      */
 507     parseCsqHeader();
 508   }
 509
 510   /**
 511    * Reads metadata (such as INFO field descriptions and datatypes) and saves
 512    * them for future reference
 513    *
 514    * @param theSourceId
 515    */
 516   void saveMetadata(String theSourceId)
 517   {
 518     List<Pattern> vcfFieldPatterns = getFieldMatchers(VCF_FIELDS_PREF,
 519             DEFAULT_VCF_FIELDS);
 520     vcfFieldsOfInterest = new ArrayList<>();
 521
 522     FeatureSource metadata = new FeatureSource(theSourceId);
 523
 524     for (VCFInfoHeaderLine info : header.getInfoHeaderLines())
 525     {
 526       String attributeId = info.getID();
 527       String desc = info.getDescription();
 528       VCFHeaderLineType type = info.getType();
 529       FeatureAttributeType attType = null;
 530       switch (type)
 531       {
 532       case Character:
 533         attType = FeatureAttributeType.Character;
 534         break;
 535       case Flag:
 536         attType = FeatureAttributeType.Flag;
 537         break;
 538       case Float:
 539         attType = FeatureAttributeType.Float;
 540         break;
 541       case Integer:
 542         attType = FeatureAttributeType.Integer;
 543         break;
 544       case String:
 545         attType = FeatureAttributeType.String;
 546         break;
 547       }
 548       metadata.setAttributeName(attributeId, desc);
 549       metadata.setAttributeType(attributeId, attType);
 550
 551       if (isFieldWanted(attributeId, vcfFieldPatterns))
 552       {
 553         vcfFieldsOfInterest.add(attributeId);
 554       }
 555     }
 556
 557     FeatureSources.getInstance().addSource(theSourceId, metadata);
 558   }
 559
 560   /**
 561    * Answers true if the field id is matched by any of the filter patterns, else
 562    * false. Matching is against regular expression patterns, and is not
 563    * case-sensitive.
 564    *
 565    * @param id
 566    * @param filters
 567    * @return
 568    */
 569   private boolean isFieldWanted(String id, List<Pattern> filters)
 570   {
 571     for (Pattern p : filters)
 572     {
 573       if (p.matcher(id.toUpperCase(Locale.ROOT)).matches())
 574       {
 575         return true;
 576       }
 577     }
 578     return false;
 579   }
 580
 581   /**
 582    * Records 'wanted' fields defined in the CSQ INFO header (if there is one).
 583    * Also records the position of selected fields (Allele, ALLELE_NUM, Feature)
 584    * required for processing.
 585    * <p>
 586    * CSQ fields are declared in the CSQ INFO Description e.g.
 587    * <p>
 588    * Description="Consequence ...from ... VEP. Format: Allele|Consequence|...
 589    */
 590   protected void parseCsqHeader()
 591   {
 592     List<Pattern> vepFieldFilters = getFieldMatchers(VEP_FIELDS_PREF,
 593             DEFAULT_VEP_FIELDS);
 594     vepFieldsOfInterest = new HashMap<>();
 595
 596     VCFInfoHeaderLine csqInfo = header.getInfoHeaderLine(CSQ_FIELD);
 597     if (csqInfo == null)
 598     {
 599       return;
 600     }
 601
 602     /*
 603      * parse out the pipe-separated list of CSQ fields; we assume here that
 604      * these form the last part of the description, and contain no spaces
 605      */
 606     String desc = csqInfo.getDescription();
 607     int spacePos = desc.lastIndexOf(" ");
 608     desc = desc.substring(spacePos + 1);
 609
 610     if (desc != null)
 611     {
 612       String[] format = desc.split(PIPE_REGEX);
 613       int index = 0;
 614       for (String field : format)
 615       {
 616         if (CSQ_CONSEQUENCE_KEY.equals(field))
 617         {
 618           csqConsequenceFieldIndex = index;
 619         }
 620         if (CSQ_ALLELE_NUM_KEY.equals(field))
 621         {
 622           csqAlleleNumberFieldIndex = index;
 623         }
 624         if (CSQ_ALLELE_KEY.equals(field))
 625         {
 626           csqAlleleFieldIndex = index;
 627         }
 628         if (CSQ_FEATURE_KEY.equals(field))
 629         {
 630           csqFeatureFieldIndex = index;
 631         }
 632
 633         if (isFieldWanted(field, vepFieldFilters))
 634         {
 635           vepFieldsOfInterest.put(index, field);
 636         }
 637
 638         index++;
 639       }
 640     }
 641   }
 642
 643   /**
 644    * Reads the Preference value for the given key, with default specified if no
 645    * preference set. The value is interpreted as a comma-separated list of
 646    * regular expressions, and converted into a list of compiled patterns ready
 647    * for matching. Patterns are forced to upper-case for non-case-sensitive
 648    * matching.
 649    * <p>
 650    * This supports user-defined filters for fields of interest to capture while
 651    * processing data. For example, VCF_FIELDS = AF,AC* would mean that VCF INFO
 652    * fields with an ID of AF, or starting with AC, would be matched.
 653    *
 654    * @param key
 655    * @param def
 656    * @return
 657    */
 658   private List<Pattern> getFieldMatchers(String key, String def)
 659   {
 660     String pref = Cache.getDefault(key, def);
 661     List<Pattern> patterns = new ArrayList<>();
 662     String[] tokens = pref.split(",");
 663     for (String token : tokens)
 664     {
 665       try
 666       {
 667       patterns.add(Pattern.compile(token.toUpperCase(Locale.ROOT)));
 668       } catch (PatternSyntaxException e)
 669       {
 670         System.err.println("Invalid pattern ignored: " + token);
 671       }
 672     }
 673     return patterns;
 674   }
 675
 676   /**
 677    * Transfers VCF features to sequences to which this sequence has a mapping.
 678    * If the mapping is 3:1, computes peptide variants from nucleotide variants.
 679    *
 680    * @param seq
 681    */
 682   protected void transferAddedFeatures(SequenceI seq)
 683   {
 684     DBRefEntry[] dbrefs = seq.getDBRefs();
 685     if (dbrefs == null)
 686     {
 687       return;
 688     }
 689     for (DBRefEntry dbref : dbrefs)
 690     {
 691       Mapping mapping = dbref.getMap();
 692       if (mapping == null || mapping.getTo() == null)
 693       {
 694         continue;
 695       }
 696
 697       SequenceI mapTo = mapping.getTo();
 698       MapList map = mapping.getMap();
 699       if (map.getFromRatio() == 3)
 700       {
 701         /*
 702          * dna-to-peptide product mapping
 703          */
 704         // JAL-3187 render on the fly instead
 705         // AlignmentUtils.computeProteinFeatures(seq, mapTo, map);
 706       }
 707       else
 708       {
 709         /*
 710          * nucleotide-to-nucleotide mapping e.g. transcript to CDS
 711          */
 712         List<SequenceFeature> features = seq.getFeatures()
 713                 .getPositionalFeatures(SequenceOntologyI.SEQUENCE_VARIANT);
 714         for (SequenceFeature sf : features)
 715         {
 716           if (FEATURE_GROUP_VCF.equals(sf.getFeatureGroup()))
 717           {
 718             transferFeature(sf, mapTo, map);
 719           }
 720         }
 721       }
 722     }
 723   }
 724
 725   /**
 726    * Tries to add overlapping variants read from a VCF file to the given sequence,
 727    * and returns the number of variant features added
 728    *
 729    * @param seq
 730    * @return
 731    */
 732   protected int loadSequenceVCF(SequenceI seq)
 733   {
 734     VCFMap vcfMap = getVcfMap(seq);
 735     if (vcfMap == null)
 736     {
 737       return 0;
 738     }
 739
 740     /*
 741      * work with the dataset sequence here
 742      */
 743     SequenceI dss = seq.getDatasetSequence();
 744     if (dss == null)
 745     {
 746       dss = seq;
 747     }
 748     return addVcfVariants(dss, vcfMap);
 749   }
 750
 751   /**
 752    * Answers a map from sequence coordinates to VCF chromosome ranges
 753    *
 754    * @param seq
 755    * @return
 756    */
 757   private VCFMap getVcfMap(SequenceI seq)
 758   {
 759     /*
 760      * simplest case: sequence has id and length matching a VCF contig
 761      */
 762     VCFMap vcfMap = null;
 763     if (dictionary != null)
 764     {
 765       vcfMap = getContigMap(seq);
 766     }
 767     if (vcfMap != null)
 768     {
 769       return vcfMap;
 770     }
 771
 772     /*
 773      * otherwise, map to VCF from chromosomal coordinates
 774      * of the sequence (if known)
 775      */
 776     GeneLociI seqCoords = seq.getGeneLoci();
 777     if (seqCoords == null)
 778     {
 779       Cache.log.warn(String.format(
 780               "Can't query VCF for %s as chromosome coordinates not known",
 781               seq.getName()));
 782       return null;
 783     }
 784
 785     String species = seqCoords.getSpeciesId();
 786     String chromosome = seqCoords.getChromosomeId();
 787     String seqRef = seqCoords.getAssemblyId();
 788     MapList map = seqCoords.getMapping();
 789
 790     // note this requires the configured species to match that
 791     // returned with the Ensembl sequence; todo: support aliases?
 792     if (!vcfSpecies.equalsIgnoreCase(species))
 793     {
 794       Cache.log.warn("No VCF loaded to " + seq.getName()
 795               + " as species not matched");
 796       return null;
 797     }
 798
 799     if (seqRef.equalsIgnoreCase(vcfAssembly))
 800     {
 801       return new VCFMap(chromosome, map);
 802     }
 803
 804     /*
 805      * VCF data has a different reference assembly to the sequence:
 806      * query Ensembl to map chromosomal coordinates from sequence to VCF
 807      */
 808     List<int[]> toVcfRanges = new ArrayList<>();
 809     List<int[]> fromSequenceRanges = new ArrayList<>();
 810
 811     for (int[] range : map.getToRanges())
 812     {
 813       int[] fromRange = map.locateInFrom(range[0], range[1]);
 814       if (fromRange == null)
 815       {
 816         // corrupted map?!?
 817         continue;
 818       }
 819
 820       int[] newRange = mapReferenceRange(range, chromosome, "human", seqRef,
 821               vcfAssembly);
 822       if (newRange == null)
 823       {
 824         Cache.log.error(
 825                 String.format("Failed to map %s:%s:%s:%d:%d to %s", species,
 826                         chromosome, seqRef, range[0], range[1],
 827                         vcfAssembly));
 828         continue;
 829       }
 830       else
 831       {
 832         toVcfRanges.add(newRange);
 833         fromSequenceRanges.add(fromRange);
 834       }
 835     }
 836
 837     return new VCFMap(chromosome,
 838             new MapList(fromSequenceRanges, toVcfRanges, 1, 1));
 839   }
 840
 841   /**
 842    * If the sequence id matches a contig declared in the VCF file, and the
 843    * sequence length matches the contig length, then returns a 1:1 map of the
 844    * sequence to the contig, else returns null
 845    *
 846    * @param seq
 847    * @return
 848    */
 849   private VCFMap getContigMap(SequenceI seq)
 850   {
 851     String id = seq.getName();
 852     SAMSequenceRecord contig = dictionary.getSequence(id);
 853     if (contig != null)
 854     {
 855       int len = seq.getLength();
 856       if (len == contig.getSequenceLength())
 857       {
 858         MapList map = new MapList(new int[] { 1, len },
 859                 new int[]
 860                 { 1, len }, 1, 1);
 861         return new VCFMap(id, map);
 862       }
 863     }
 864     return null;
 865   }
 866
 867   /**
 868    * Queries the VCF reader for any variants that overlap the mapped chromosome
 869    * ranges of the sequence, and adds as variant features. Returns the number of
 870    * overlapping variants found.
 871    *
 872    * @param seq
 873    * @param map
 874    *          mapping from sequence to VCF coordinates
 875    * @return
 876    */
 877   protected int addVcfVariants(SequenceI seq, VCFMap map)
 878   {
 879     boolean forwardStrand = map.map.isToForwardStrand();
 880
 881     /*
 882      * query the VCF for overlaps of each contiguous chromosomal region
 883      */
 884     int count = 0;
 885
 886     for (int[] range : map.map.getToRanges())
 887     {
 888       int vcfStart = Math.min(range[0], range[1]);
 889       int vcfEnd = Math.max(range[0], range[1]);
 890       try
 891       {
 892         CloseableIterator<VariantContext> variants = reader
 893                 .query(map.chromosome, vcfStart, vcfEnd);
 894         while (variants.hasNext())
 895         {
 896           VariantContext variant = variants.next();
 897
 898           int[] featureRange = map.map.locateInFrom(variant.getStart(),
 899                   variant.getEnd());
 900
 901           if (featureRange != null)
 902           {
 903             int featureStart = Math.min(featureRange[0], featureRange[1]);
 904             int featureEnd = Math.max(featureRange[0], featureRange[1]);
 905             count += addAlleleFeatures(seq, variant, featureStart,
 906                     featureEnd, forwardStrand);
 907           }
 908         }
 909         variants.close();
 910       } catch (TribbleException e)
 911       {
 912         /*
 913          * RuntimeException throwable by htsjdk
 914          */
 915         String msg = String.format("Error reading VCF for %s:%d-%d: %s ",
 916                 map.chromosome, vcfStart, vcfEnd,e.getLocalizedMessage());
 917         Cache.log.error(msg);
 918       }
 919     }
 920
 921     return count;
 922   }
 923
 924   /**
 925    * A convenience method to get an attribute value for an alternate allele
 926    *
 927    * @param variant
 928    * @param attributeName
 929    * @param alleleIndex
 930    * @return
 931    */
 932   protected String getAttributeValue(VariantContext variant,
 933           String attributeName, int alleleIndex)
 934   {
 935     Object att = variant.getAttribute(attributeName);
 936
 937     if (att instanceof String)
 938     {
 939       return (String) att;
 940     }
 941     else if (att instanceof ArrayList)
 942     {
 943       return ((List<String>) att).get(alleleIndex);
 944     }
 945
 946     return null;
 947   }
 948
 949   /**
 950    * Adds one variant feature for each allele in the VCF variant record, and
 951    * returns the number of features added.
 952    *
 953    * @param seq
 954    * @param variant
 955    * @param featureStart
 956    * @param featureEnd
 957    * @param forwardStrand
 958    * @return
 959    */
 960   protected int addAlleleFeatures(SequenceI seq, VariantContext variant,
 961           int featureStart, int featureEnd, boolean forwardStrand)
 962   {
 963     int added = 0;
 964
 965     /*
 966      * Javadoc says getAlternateAlleles() imposes no order on the list returned
 967      * so we proceed defensively to get them in strict order
 968      */
 969     int altAlleleCount = variant.getAlternateAlleles().size();
 970     for (int i = 0; i < altAlleleCount; i++)
 971     {
 972       added += addAlleleFeature(seq, variant, i, featureStart, featureEnd,
 973               forwardStrand);
 974     }
 975     return added;
 976   }
 977
 978   /**
 979    * Inspects one allele and attempts to add a variant feature for it to the
 980    * sequence. The additional data associated with this allele is extracted to
 981    * store in the feature's key-value map. Answers the number of features added (0
 982    * or 1).
 983    *
 984    * @param seq
 985    * @param variant
 986    * @param altAlleleIndex
 987    *          (0, 1..)
 988    * @param featureStart
 989    * @param featureEnd
 990    * @param forwardStrand
 991    * @return
 992    */
 993   protected int addAlleleFeature(SequenceI seq, VariantContext variant,
 994           int altAlleleIndex, int featureStart, int featureEnd,
 995           boolean forwardStrand)
 996   {
 997     String reference = variant.getReference().getBaseString();
 998     Allele alt = variant.getAlternateAllele(altAlleleIndex);
 999     String allele = alt.getBaseString();
1000
1001     /*
1002      * insertion after a genomic base, if on reverse strand, has to be
1003      * converted to insertion of complement after the preceding position
1004      */
1005     int referenceLength = reference.length();
1006     if (!forwardStrand && allele.length() > referenceLength
1007             && allele.startsWith(reference))
1008     {
1009       featureStart -= referenceLength;
1010       featureEnd = featureStart;
1011       char insertAfter = seq.getCharAt(featureStart - seq.getStart());
1012       reference = Dna.reverseComplement(String.valueOf(insertAfter));
1013       allele = allele.substring(referenceLength) + reference;
1014     }
1015
1016     /*
1017      * build the ref,alt allele description e.g. "G,A", using the base
1018      * complement if the sequence is on the reverse strand
1019      */
1020     StringBuilder sb = new StringBuilder();
1021     sb.append(forwardStrand ? reference : Dna.reverseComplement(reference));
1022     sb.append(COMMA);
1023     sb.append(forwardStrand ? allele : Dna.reverseComplement(allele));
1024     String alleles = sb.toString(); // e.g. G,A
1025
1026     /*
1027      * pick out the consequence data (if any) that is for the current allele
1028      * and feature (transcript) that matches the current sequence
1029      */
1030     String consequence = getConsequenceForAlleleAndFeature(variant, CSQ_FIELD,
1031             altAlleleIndex, csqAlleleFieldIndex,
1032             csqAlleleNumberFieldIndex, seq.getName().toLowerCase(),
1033             csqFeatureFieldIndex);
1034
1035     /*
1036      * pick out the ontology term for the consequence type
1037      */
1038     String type = SequenceOntologyI.SEQUENCE_VARIANT;
1039     if (consequence != null)
1040     {
1041       type = getOntologyTerm(consequence);
1042     }
1043
1044     SequenceFeature sf = new SequenceFeature(type, alleles, featureStart,
1045             featureEnd, FEATURE_GROUP_VCF);
1046     sf.setSource(sourceId);
1047
1048     /*
1049      * save the derived alleles as a named attribute; this will be
1050      * needed when Jalview computes derived peptide variants
1051      */
1052     addFeatureAttribute(sf, Gff3Helper.ALLELES, alleles);
1053
1054     /*
1055      * add selected VCF fixed column data as feature attributes
1056      */
1057     addFeatureAttribute(sf, VCF_POS, String.valueOf(variant.getStart()));
1058     addFeatureAttribute(sf, VCF_ID, variant.getID());
1059     addFeatureAttribute(sf, VCF_QUAL,
1060             String.valueOf(variant.getPhredScaledQual()));
1061     addFeatureAttribute(sf, VCF_FILTER, getFilter(variant));
1062
1063     addAlleleProperties(variant, sf, altAlleleIndex, consequence);
1064
1065     seq.addSequenceFeature(sf);
1066
1067     return 1;
1068   }
1069
1070   /**
1071    * Answers the VCF FILTER value for the variant - or an approximation to it.
1072    * This field is either PASS, or a semi-colon separated list of filters not
1073    * passed. htsjdk saves filters as a HashSet, so the order when reassembled into
1074    * a list may be different.
1075    *
1076    * @param variant
1077    * @return
1078    */
1079   String getFilter(VariantContext variant)
1080   {
1081     Set<String> filters = variant.getFilters();
1082     if (filters.isEmpty())
1083     {
1084       return NO_VALUE;
1085     }
1086     Iterator<String> iterator = filters.iterator();
1087     String first = iterator.next();
1088     if (filters.size() == 1)
1089     {
1090       return first;
1091     }
1092
1093     StringBuilder sb = new StringBuilder(first);
1094     while (iterator.hasNext())
1095     {
1096       sb.append(";").append(iterator.next());
1097     }
1098
1099     return sb.toString();
1100   }
1101
1102   /**
1103    * Adds one feature attribute unless the value is null, empty or '.'
1104    *
1105    * @param sf
1106    * @param key
1107    * @param value
1108    */
1109   void addFeatureAttribute(SequenceFeature sf, String key, String value)
1110   {
1111     if (value != null && !value.isEmpty() && !NO_VALUE.equals(value))
1112     {
1113       sf.setValue(key, value);
1114     }
1115   }
1116
1117   /**
1118    * Determines the Sequence Ontology term to use for the variant feature type in
1119    * Jalview. The default is 'sequence_variant', but a more specific term is used
1120    * if:
1121    * <ul>
1122    * <li>VEP (or SnpEff) Consequence annotation is included in the VCF</li>
1123    * <li>sequence id can be matched to VEP Feature (or SnpEff Feature_ID)</li>
1124    * </ul>
1125    *
1126    * @param consequence
1127    * @return
1128    * @see http://www.sequenceontology.org/browser/current_svn/term/SO:0001060
1129    */
1130   String getOntologyTerm(String consequence)
1131   {
1132     String type = SequenceOntologyI.SEQUENCE_VARIANT;
1133
1134     /*
1135      * could we associate Consequence data with this allele and feature (transcript)?
1136      * if so, prefer the consequence term from that data
1137      */
1138     if (csqAlleleFieldIndex == -1) // && snpEffAlleleFieldIndex == -1
1139     {
1140       /*
1141        * no Consequence data so we can't refine the ontology term
1142        */
1143       return type;
1144     }
1145
1146     if (consequence != null)
1147     {
1148       String[] csqFields = consequence.split(PIPE_REGEX);
1149       if (csqFields.length > csqConsequenceFieldIndex)
1150       {
1151         type = csqFields[csqConsequenceFieldIndex];
1152       }
1153     }
1154     else
1155     {
1156       // todo the same for SnpEff consequence data matching if wanted
1157     }
1158
1159     /*
1160      * if of the form (e.g.) missense_variant&splice_region_variant,
1161      * just take the first ('most severe') consequence
1162      */
1163     if (type != null)
1164     {
1165       int pos = type.indexOf('&');
1166       if (pos > 0)
1167       {
1168         type = type.substring(0, pos);
1169       }
1170     }
1171     return type;
1172   }
1173
1174   /**
1175    * Returns matched consequence data if it can be found, else null.
1176    * <ul>
1177    * <li>inspects the VCF data for key 'vcfInfoId'</li>
1178    * <li>splits this on comma (to distinct consequences)</li>
1179    * <li>returns the first consequence (if any) where</li>
1180    * <ul>
1181    * <li>the allele matches the altAlleleIndex'th allele of variant</li>
1182    * <li>the feature matches the sequence name (e.g. transcript id)</li>
1183    * </ul>
1184    * </ul>
1185    * If matched, the consequence is returned (as pipe-delimited fields).
1186    *
1187    * @param variant
1188    * @param vcfInfoId
1189    * @param altAlleleIndex
1190    * @param alleleFieldIndex
1191    * @param alleleNumberFieldIndex
1192    * @param seqName
1193    * @param featureFieldIndex
1194    * @return
1195    */
1196   private String getConsequenceForAlleleAndFeature(VariantContext variant,
1197           String vcfInfoId, int altAlleleIndex, int alleleFieldIndex,
1198           int alleleNumberFieldIndex,
1199           String seqName, int featureFieldIndex)
1200   {
1201     if (alleleFieldIndex == -1 || featureFieldIndex == -1)
1202     {
1203       return null;
1204     }
1205     Object value = variant.getAttribute(vcfInfoId);
1206
1207     if (value == null || !(value instanceof List<?>))
1208     {
1209       return null;
1210     }
1211
1212     /*
1213      * inspect each consequence in turn (comma-separated blocks
1214      * extracted by htsjdk)
1215      */
1216     List<String> consequences = (List<String>) value;
1217
1218     for (String consequence : consequences)
1219     {
1220       String[] csqFields = consequence.split(PIPE_REGEX);
1221       if (csqFields.length > featureFieldIndex)
1222       {
1223         String featureIdentifier = csqFields[featureFieldIndex];
1224         if (featureIdentifier.length() > 4
1225                 && seqName.indexOf(featureIdentifier.toLowerCase()) > -1)
1226         {
1227           /*
1228            * feature (transcript) matched - now check for allele match
1229            */
1230           if (matchAllele(variant, altAlleleIndex, csqFields,
1231                   alleleFieldIndex, alleleNumberFieldIndex))
1232           {
1233             return consequence;
1234           }
1235         }
1236       }
1237     }
1238     return null;
1239   }
1240
1241   private boolean matchAllele(VariantContext variant, int altAlleleIndex,
1242           String[] csqFields, int alleleFieldIndex,
1243           int alleleNumberFieldIndex)
1244   {
1245     /*
1246      * if ALLELE_NUM is present, it must match altAlleleIndex
1247      * NB first alternate allele is 1 for ALLELE_NUM, 0 for altAlleleIndex
1248      */
1249     if (alleleNumberFieldIndex > -1)
1250     {
1251       if (csqFields.length <= alleleNumberFieldIndex)
1252       {
1253         return false;
1254       }
1255       String alleleNum = csqFields[alleleNumberFieldIndex];
1256       return String.valueOf(altAlleleIndex + 1).equals(alleleNum);
1257     }
1258
1259     /*
1260      * else consequence allele must match variant allele
1261      */
1262     if (alleleFieldIndex > -1 && csqFields.length > alleleFieldIndex)
1263     {
1264       String csqAllele = csqFields[alleleFieldIndex];
1265       String vcfAllele = variant.getAlternateAllele(altAlleleIndex)
1266               .getBaseString();
1267       return csqAllele.equals(vcfAllele);
1268     }
1269     return false;
1270   }
1271
1272   /**
1273    * Add any allele-specific VCF key-value data to the sequence feature
1274    *
1275    * @param variant
1276    * @param sf
1277    * @param altAlelleIndex
1278    *          (0, 1..)
1279    * @param consequence
1280    *          if not null, the consequence specific to this sequence (transcript
1281    *          feature) and allele
1282    */
1283   protected void addAlleleProperties(VariantContext variant,
1284           SequenceFeature sf, final int altAlelleIndex, String consequence)
1285   {
1286     Map<String, Object> atts = variant.getAttributes();
1287
1288     for (Entry<String, Object> att : atts.entrySet())
1289     {
1290       String key = att.getKey();
1291
1292       /*
1293        * extract Consequence data (if present) that we are able to
1294        * associated with the allele for this variant feature
1295        */
1296       if (CSQ_FIELD.equals(key))
1297       {
1298         addConsequences(variant, sf, consequence);
1299         continue;
1300       }
1301
1302       /*
1303        * filter out fields we don't want to capture
1304        */
1305       if (!vcfFieldsOfInterest.contains(key))
1306       {
1307         continue;
1308       }
1309
1310       /*
1311        * we extract values for other data which are allele-specific;
1312        * these may be per alternate allele (INFO[key].Number = 'A')
1313        * or per allele including reference (INFO[key].Number = 'R')
1314        */
1315       VCFInfoHeaderLine infoHeader = header.getInfoHeaderLine(key);
1316       if (infoHeader == null)
1317       {
1318         /*
1319          * can't be sure what data belongs to this allele, so
1320          * play safe and don't take any
1321          */
1322         continue;
1323       }
1324
1325       VCFHeaderLineCount number = infoHeader.getCountType();
1326       int index = altAlelleIndex;
1327       if (number == VCFHeaderLineCount.R)
1328       {
1329         /*
1330          * one value per allele including reference, so bump index
1331          * e.g. the 3rd value is for the  2nd alternate allele
1332          */
1333         index++;
1334       }
1335       else if (number != VCFHeaderLineCount.A)
1336       {
1337         /*
1338          * don't save other values as not allele-related
1339          */
1340         continue;
1341       }
1342
1343       /*
1344        * take the index'th value
1345        */
1346       String value = getAttributeValue(variant, key, index);
1347       if (value != null && isValid(variant, key, value))
1348       {
1349         /*
1350          * decode colon, semicolon, equals sign, percent sign, comma (only)
1351          * as required by the VCF specification (para 1.2)
1352          */
1353         value = StringUtils.urlDecode(value, VCF_ENCODABLE);
1354         addFeatureAttribute(sf, key, value);
1355       }
1356     }
1357   }
1358
1359   /**
1360    * Answers true for '.', null, or an empty value, or if the INFO type is String.
1361    * If the INFO type is Integer or Float, answers false if the value is not in
1362    * valid format.
1363    *
1364    * @param variant
1365    * @param infoId
1366    * @param value
1367    * @return
1368    */
1369   protected boolean isValid(VariantContext variant, String infoId,
1370           String value)
1371   {
1372     if (value == null || value.isEmpty() || NO_VALUE.equals(value))
1373     {
1374       return true;
1375     }
1376     VCFInfoHeaderLine infoHeader = header.getInfoHeaderLine(infoId);
1377     if (infoHeader == null)
1378     {
1379       Cache.log.error("Field " + infoId + " has no INFO header");
1380       return false;
1381     }
1382     VCFHeaderLineType infoType = infoHeader.getType();
1383     try
1384     {
1385       if (infoType == VCFHeaderLineType.Integer)
1386       {
1387         Integer.parseInt(value);
1388       }
1389       else if (infoType == VCFHeaderLineType.Float)
1390       {
1391         Float.parseFloat(value);
1392       }
1393     } catch (NumberFormatException e)
1394     {
1395       logInvalidValue(variant, infoId, value);
1396       return false;
1397     }
1398     return true;
1399   }
1400
1401   /**
1402    * Logs an error message for malformed data; duplicate messages (same id and
1403    * value) are not logged
1404    *
1405    * @param variant
1406    * @param infoId
1407    * @param value
1408    */
1409   private void logInvalidValue(VariantContext variant, String infoId,
1410           String value)
1411   {
1412     if (badData == null)
1413     {
1414       badData = new HashSet<>();
1415     }
1416     String token = infoId + ":" + value;
1417     if (!badData.contains(token))
1418     {
1419       badData.add(token);
1420       Cache.log.error(String.format("Invalid VCF data at %s:%d %s=%s",
1421               variant.getContig(), variant.getStart(), infoId, value));
1422     }
1423   }
1424
1425   /**
1426    * Inspects CSQ data blocks (consequences) and adds attributes on the sequence
1427    * feature.
1428    * <p>
1429    * If <code>myConsequence</code> is not null, then this is the specific
1430    * consequence data (pipe-delimited fields) that is for the current allele and
1431    * transcript (sequence) being processed)
1432    *
1433    * @param variant
1434    * @param sf
1435    * @param myConsequence
1436    */
1437   protected void addConsequences(VariantContext variant, SequenceFeature sf,
1438           String myConsequence)
1439   {
1440     Object value = variant.getAttribute(CSQ_FIELD);
1441
1442     if (value == null || !(value instanceof List<?>))
1443     {
1444       return;
1445     }
1446
1447     List<String> consequences = (List<String>) value;
1448
1449     /*
1450      * inspect CSQ consequences; restrict to the consequence
1451      * associated with the current transcript (Feature)
1452      */
1453     Map<String, String> csqValues = new HashMap<>();
1454
1455     for (String consequence : consequences)
1456     {
1457       if (myConsequence == null || myConsequence.equals(consequence))
1458       {
1459         String[] csqFields = consequence.split(PIPE_REGEX);
1460
1461         /*
1462          * inspect individual fields of this consequence, copying non-null
1463          * values which are 'fields of interest'
1464          */
1465         int i = 0;
1466         for (String field : csqFields)
1467         {
1468           if (field != null && field.length() > 0)
1469           {
1470             String id = vepFieldsOfInterest.get(i);
1471             if (id != null)
1472             {
1473               /*
1474                * VCF spec requires encoding of special characters e.g. '='
1475                * so decode them here before storing
1476                */
1477               field = StringUtils.urlDecode(field, VCF_ENCODABLE);
1478               csqValues.put(id, field);
1479             }
1480           }
1481           i++;
1482         }
1483       }
1484     }
1485
1486     if (!csqValues.isEmpty())
1487     {
1488       sf.setValue(CSQ_FIELD, csqValues);
1489     }
1490   }
1491
1492   /**
1493    * A convenience method to complement a dna base and return the string value
1494    * of its complement
1495    *
1496    * @param reference
1497    * @return
1498    */
1499   protected String complement(byte[] reference)
1500   {
1501     return String.valueOf(Dna.getComplement((char) reference[0]));
1502   }
1503
1504   /**
1505    * Determines the location of the query range (chromosome positions) in a
1506    * different reference assembly.
1507    * <p>
1508    * If the range is just a subregion of one for which we already have a mapping
1509    * (for example, an exon sub-region of a gene), then the mapping is just
1510    * computed arithmetically.
1511    * <p>
1512    * Otherwise, calls the Ensembl REST service that maps from one assembly
1513    * reference's coordinates to another's
1514    *
1515    * @param queryRange
1516    *          start-end chromosomal range in 'fromRef' coordinates
1517    * @param chromosome
1518    * @param species
1519    * @param fromRef
1520    *          assembly reference for the query coordinates
1521    * @param toRef
1522    *          assembly reference we wish to translate to
1523    * @return the start-end range in 'toRef' coordinates
1524    */
1525   protected int[] mapReferenceRange(int[] queryRange, String chromosome,
1526           String species, String fromRef, String toRef)
1527   {
1528     /*
1529      * first try shorcut of computing the mapping as a subregion of one
1530      * we already have (e.g. for an exon, if we have the gene mapping)
1531      */
1532     int[] mappedRange = findSubsumedRangeMapping(queryRange, chromosome,
1533             species, fromRef, toRef);
1534     if (mappedRange != null)
1535     {
1536       return mappedRange;
1537     }
1538
1539     /*
1540      * call (e.g.) http://rest.ensembl.org/map/human/GRCh38/17:45051610..45109016:1/GRCh37
1541      */
1542     EnsemblMap mapper = new EnsemblMap();
1543     int[] mapping = mapper.getAssemblyMapping(species, chromosome, fromRef,
1544             toRef, queryRange);
1545
1546     if (mapping == null)
1547     {
1548       // mapping service failure
1549       return null;
1550     }
1551
1552     /*
1553      * save mapping for possible future re-use
1554      */
1555     String key = makeRangesKey(chromosome, species, fromRef, toRef);
1556     if (!assemblyMappings.containsKey(key))
1557     {
1558       assemblyMappings.put(key, new HashMap<int[], int[]>());
1559     }
1560
1561     assemblyMappings.get(key).put(queryRange, mapping);
1562
1563     return mapping;
1564   }
1565
1566   /**
1567    * If we already have a 1:1 contiguous mapping which subsumes the given query
1568    * range, this method just calculates and returns the subset of that mapping,
1569    * else it returns null. In practical terms, if a gene has a contiguous
1570    * mapping between (for example) GRCh37 and GRCh38, then we assume that its
1571    * subsidiary exons occupy unchanged relative positions, and just compute
1572    * these as offsets, rather than do another lookup of the mapping.
1573    * <p>
1574    * If in future these assumptions prove invalid (e.g. for bacterial dna?!),
1575    * simply remove this method or let it always return null.
1576    * <p>
1577    * Warning: many rapid calls to the /map service map result in a 429 overload
1578    * error response
1579    *
1580    * @param queryRange
1581    * @param chromosome
1582    * @param species
1583    * @param fromRef
1584    * @param toRef
1585    * @return
1586    */
1587   protected int[] findSubsumedRangeMapping(int[] queryRange, String chromosome,
1588           String species, String fromRef, String toRef)
1589   {
1590     String key = makeRangesKey(chromosome, species, fromRef, toRef);
1591     if (assemblyMappings.containsKey(key))
1592     {
1593       Map<int[], int[]> mappedRanges = assemblyMappings.get(key);
1594       for (Entry<int[], int[]> mappedRange : mappedRanges.entrySet())
1595       {
1596         int[] fromRange = mappedRange.getKey();
1597         int[] toRange = mappedRange.getValue();
1598         if (fromRange[1] - fromRange[0] == toRange[1] - toRange[0])
1599         {
1600           /*
1601            * mapping is 1:1 in length, so we trust it to have no discontinuities
1602            */
1603           if (MappingUtils.rangeContains(fromRange, queryRange))
1604           {
1605             /*
1606              * fromRange subsumes our query range
1607              */
1608             int offset = queryRange[0] - fromRange[0];
1609             int mappedRangeFrom = toRange[0] + offset;
1610             int mappedRangeTo = mappedRangeFrom + (queryRange[1] - queryRange[0]);
1611             return new int[] { mappedRangeFrom, mappedRangeTo };
1612           }
1613         }
1614       }
1615     }
1616     return null;
1617   }
1618
1619   /**
1620    * Transfers the sequence feature to the target sequence, locating its start
1621    * and end range based on the mapping. Features which do not overlap the
1622    * target sequence are ignored.
1623    *
1624    * @param sf
1625    * @param targetSequence
1626    * @param mapping
1627    *          mapping from the feature's coordinates to the target sequence
1628    */
1629   protected void transferFeature(SequenceFeature sf,
1630           SequenceI targetSequence, MapList mapping)
1631   {
1632     int[] mappedRange = mapping.locateInTo(sf.getBegin(), sf.getEnd());
1633
1634     if (mappedRange != null)
1635     {
1636       String group = sf.getFeatureGroup();
1637       int newBegin = Math.min(mappedRange[0], mappedRange[1]);
1638       int newEnd = Math.max(mappedRange[0], mappedRange[1]);
1639       SequenceFeature copy = new SequenceFeature(sf, newBegin, newEnd,
1640               group, sf.getScore());
1641       targetSequence.addSequenceFeature(copy);
1642     }
1643   }
1644
1645   /**
1646    * Formats a ranges map lookup key
1647    *
1648    * @param chromosome
1649    * @param species
1650    * @param fromRef
1651    * @param toRef
1652    * @return
1653    */
1654   protected static String makeRangesKey(String chromosome, String species,
1655           String fromRef, String toRef)
1656   {
1657     return species + EXCL + chromosome + EXCL + fromRef + EXCL
1658             + toRef;
1659   }
1660 }