2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.analysis;
23 import java.util.Locale;
25 import jalview.commands.RemoveGapColCommand;
26 import jalview.datamodel.AlignedCodon;
27 import jalview.datamodel.AlignedCodonFrame;
28 import jalview.datamodel.AlignedCodonFrame.SequenceToSequenceMapping;
29 import jalview.datamodel.Alignment;
30 import jalview.datamodel.AlignmentAnnotation;
31 import jalview.datamodel.AlignmentI;
32 import jalview.datamodel.DBRefEntry;
33 import jalview.datamodel.GeneLociI;
34 import jalview.datamodel.IncompleteCodonException;
35 import jalview.datamodel.Mapping;
36 import jalview.datamodel.Sequence;
37 import jalview.datamodel.SequenceFeature;
38 import jalview.datamodel.SequenceGroup;
39 import jalview.datamodel.SequenceI;
40 import jalview.datamodel.features.SequenceFeatures;
41 import jalview.io.gff.SequenceOntologyI;
42 import jalview.schemes.ResidueProperties;
43 import jalview.util.Comparison;
44 import jalview.util.DBRefUtils;
45 import jalview.util.IntRangeComparator;
46 import jalview.util.MapList;
47 import jalview.util.MappingUtils;
49 import java.util.ArrayList;
50 import java.util.Arrays;
51 import java.util.Collection;
52 import java.util.Collections;
53 import java.util.HashMap;
54 import java.util.HashSet;
55 import java.util.Iterator;
56 import java.util.LinkedHashMap;
57 import java.util.List;
59 import java.util.Map.Entry;
60 import java.util.NoSuchElementException;
62 import java.util.SortedMap;
63 import java.util.TreeMap;
66 * grab bag of useful alignment manipulation operations Expect these to be
67 * refactored elsewhere at some point.
72 public class AlignmentUtils
74 private static final int CODON_LENGTH = 3;
76 private static final String SEQUENCE_VARIANT = "sequence_variant:";
79 * the 'id' attribute is provided for variant features fetched from
80 * Ensembl using its REST service with JSON format
82 public static final String VARIANT_ID = "id";
85 * A data model to hold the 'normal' base value at a position, and an optional
86 * sequence variant feature
88 static final class DnaVariant
92 SequenceFeature variant;
94 DnaVariant(String nuc)
100 DnaVariant(String nuc, SequenceFeature var)
106 public String getSource()
108 return variant == null ? null : variant.getFeatureGroup();
112 * toString for aid in the debugger only
115 public String toString()
117 return base + ":" + (variant == null ? "" : variant.getDescription());
122 * given an existing alignment, create a new alignment including all, or up to
123 * flankSize additional symbols from each sequence's dataset sequence
129 public static AlignmentI expandContext(AlignmentI core, int flankSize)
131 List<SequenceI> sq = new ArrayList<>();
133 for (SequenceI s : core.getSequences())
135 SequenceI newSeq = s.deriveSequence();
136 final int newSeqStart = newSeq.getStart() - 1;
137 if (newSeqStart > maxoffset
138 && newSeq.getDatasetSequence().getStart() < s.getStart())
140 maxoffset = newSeqStart;
146 maxoffset = Math.min(maxoffset, flankSize);
150 * now add offset left and right to create an expanded alignment
152 for (SequenceI s : sq)
155 while (ds.getDatasetSequence() != null)
157 ds = ds.getDatasetSequence();
159 int s_end = s.findPosition(s.getStart() + s.getLength());
160 // find available flanking residues for sequence
161 int ustream_ds = s.getStart() - ds.getStart();
162 int dstream_ds = ds.getEnd() - s_end;
164 // build new flanked sequence
166 // compute gap padding to start of flanking sequence
167 int offset = maxoffset - ustream_ds;
169 // padding is gapChar x ( maxoffset - min(ustream_ds, flank)
172 if (flankSize < ustream_ds)
174 // take up to flankSize residues
175 offset = maxoffset - flankSize;
176 ustream_ds = flankSize;
178 if (flankSize <= dstream_ds)
180 dstream_ds = flankSize - 1;
183 // TODO use Character.toLowerCase to avoid creating String objects?
184 char[] upstream = new String(ds
185 .getSequence(s.getStart() - 1 - ustream_ds, s.getStart() - 1))
186 .toLowerCase(Locale.ROOT).toCharArray();
187 char[] downstream = new String(
188 ds.getSequence(s_end - 1, s_end + dstream_ds)).toLowerCase(Locale.ROOT)
190 char[] coreseq = s.getSequence();
191 char[] nseq = new char[offset + upstream.length + downstream.length
193 char c = core.getGapCharacter();
196 for (; p < offset; p++)
201 System.arraycopy(upstream, 0, nseq, p, upstream.length);
202 System.arraycopy(coreseq, 0, nseq, p + upstream.length,
204 System.arraycopy(downstream, 0, nseq,
205 p + coreseq.length + upstream.length, downstream.length);
206 s.setSequence(new String(nseq));
207 s.setStart(s.getStart() - ustream_ds);
208 s.setEnd(s_end + downstream.length);
210 AlignmentI newAl = new jalview.datamodel.Alignment(
211 sq.toArray(new SequenceI[0]));
212 for (SequenceI s : sq)
214 if (s.getAnnotation() != null)
216 for (AlignmentAnnotation aa : s.getAnnotation())
218 aa.adjustForAlignment(); // JAL-1712 fix
219 newAl.addAnnotation(aa);
223 newAl.setDataset(core.getDataset());
228 * Returns the index (zero-based position) of a sequence in an alignment, or
235 public static int getSequenceIndex(AlignmentI al, SequenceI seq)
239 for (SequenceI alSeq : al.getSequences())
252 * Returns a map of lists of sequences in the alignment, keyed by sequence
253 * name. For use in mapping between different alignment views of the same
256 * @see jalview.datamodel.AlignmentI#getSequencesByName()
258 public static Map<String, List<SequenceI>> getSequencesByName(
261 Map<String, List<SequenceI>> theMap = new LinkedHashMap<>();
262 for (SequenceI seq : al.getSequences())
264 String name = seq.getName();
267 List<SequenceI> seqs = theMap.get(name);
270 seqs = new ArrayList<>();
271 theMap.put(name, seqs);
280 * Build mapping of protein to cDNA alignment. Mappings are made between
281 * sequences where the cDNA translates to the protein sequence. Any new
282 * mappings are added to the protein alignment. Returns true if any mappings
283 * either already exist or were added, else false.
285 * @param proteinAlignment
286 * @param cdnaAlignment
289 public static boolean mapProteinAlignmentToCdna(
290 final AlignmentI proteinAlignment, final AlignmentI cdnaAlignment)
292 if (proteinAlignment == null || cdnaAlignment == null)
297 Set<SequenceI> mappedDna = new HashSet<>();
298 Set<SequenceI> mappedProtein = new HashSet<>();
301 * First pass - map sequences where cross-references exist. This include
302 * 1-to-many mappings to support, for example, variant cDNA.
304 boolean mappingPerformed = mapProteinToCdna(proteinAlignment,
305 cdnaAlignment, mappedDna, mappedProtein, true);
308 * Second pass - map sequences where no cross-references exist. This only
309 * does 1-to-1 mappings and assumes corresponding sequences are in the same
310 * order in the alignments.
312 mappingPerformed |= mapProteinToCdna(proteinAlignment, cdnaAlignment,
313 mappedDna, mappedProtein, false);
314 return mappingPerformed;
318 * Make mappings between compatible sequences (where the cDNA translation
319 * matches the protein).
321 * @param proteinAlignment
322 * @param cdnaAlignment
324 * a set of mapped DNA sequences (to add to)
325 * @param mappedProtein
326 * a set of mapped Protein sequences (to add to)
328 * if true, only map sequences where xrefs exist
331 protected static boolean mapProteinToCdna(
332 final AlignmentI proteinAlignment, final AlignmentI cdnaAlignment,
333 Set<SequenceI> mappedDna, Set<SequenceI> mappedProtein,
336 boolean mappingExistsOrAdded = false;
337 List<SequenceI> thisSeqs = proteinAlignment.getSequences();
338 for (SequenceI aaSeq : thisSeqs)
340 boolean proteinMapped = false;
341 AlignedCodonFrame acf = new AlignedCodonFrame();
343 for (SequenceI cdnaSeq : cdnaAlignment.getSequences())
346 * Always try to map if sequences have xref to each other; this supports
347 * variant cDNA or alternative splicing for a protein sequence.
349 * If no xrefs, try to map progressively, assuming that alignments have
350 * mappable sequences in corresponding order. These are not
351 * many-to-many, as that would risk mixing species with similar cDNA
354 if (xrefsOnly && !AlignmentUtils.haveCrossRef(aaSeq, cdnaSeq))
360 * Don't map non-xrefd sequences more than once each. This heuristic
361 * allows us to pair up similar sequences in ordered alignments.
363 if (!xrefsOnly && (mappedProtein.contains(aaSeq)
364 || mappedDna.contains(cdnaSeq)))
368 if (mappingExists(proteinAlignment.getCodonFrames(),
369 aaSeq.getDatasetSequence(), cdnaSeq.getDatasetSequence()))
371 mappingExistsOrAdded = true;
375 MapList map = mapCdnaToProtein(aaSeq, cdnaSeq);
378 acf.addMap(cdnaSeq, aaSeq, map);
379 mappingExistsOrAdded = true;
380 proteinMapped = true;
381 mappedDna.add(cdnaSeq);
382 mappedProtein.add(aaSeq);
388 proteinAlignment.addCodonFrame(acf);
391 return mappingExistsOrAdded;
395 * Answers true if the mappings include one between the given (dataset)
398 protected static boolean mappingExists(List<AlignedCodonFrame> mappings,
399 SequenceI aaSeq, SequenceI cdnaSeq)
401 if (mappings != null)
403 for (AlignedCodonFrame acf : mappings)
405 if (cdnaSeq == acf.getDnaForAaSeq(aaSeq))
415 * Builds a mapping (if possible) of a cDNA to a protein sequence.
417 * <li>first checks if the cdna translates exactly to the protein
419 * <li>else checks for translation after removing a STOP codon</li>
420 * <li>else checks for translation after removing a START codon</li>
421 * <li>if that fails, inspect CDS features on the cDNA sequence</li>
423 * Returns null if no mapping is determined.
426 * the aligned protein sequence
428 * the aligned cdna sequence
431 public static MapList mapCdnaToProtein(SequenceI proteinSeq,
435 * Here we handle either dataset sequence set (desktop) or absent (applet).
436 * Use only the char[] form of the sequence to avoid creating possibly large
439 final SequenceI proteinDataset = proteinSeq.getDatasetSequence();
440 char[] aaSeqChars = proteinDataset != null
441 ? proteinDataset.getSequence()
442 : proteinSeq.getSequence();
443 final SequenceI cdnaDataset = cdnaSeq.getDatasetSequence();
444 char[] cdnaSeqChars = cdnaDataset != null ? cdnaDataset.getSequence()
445 : cdnaSeq.getSequence();
446 if (aaSeqChars == null || cdnaSeqChars == null)
452 * cdnaStart/End, proteinStartEnd are base 1 (for dataset sequence mapping)
454 final int mappedLength = CODON_LENGTH * aaSeqChars.length;
455 int cdnaLength = cdnaSeqChars.length;
456 int cdnaStart = cdnaSeq.getStart();
457 int cdnaEnd = cdnaSeq.getEnd();
458 final int proteinStart = proteinSeq.getStart();
459 final int proteinEnd = proteinSeq.getEnd();
462 * If lengths don't match, try ignoring stop codon (if present)
464 if (cdnaLength != mappedLength && cdnaLength > 2)
466 String lastCodon = String.valueOf(cdnaSeqChars,
467 cdnaLength - CODON_LENGTH, CODON_LENGTH).toUpperCase(Locale.ROOT);
468 for (String stop : ResidueProperties.STOP_CODONS)
470 if (lastCodon.equals(stop))
472 cdnaEnd -= CODON_LENGTH;
473 cdnaLength -= CODON_LENGTH;
480 * If lengths still don't match, try ignoring start codon.
483 if (cdnaLength != mappedLength && cdnaLength > 2
484 && String.valueOf(cdnaSeqChars, 0, CODON_LENGTH).toUpperCase(Locale.ROOT)
485 .equals(ResidueProperties.START))
487 startOffset += CODON_LENGTH;
488 cdnaStart += CODON_LENGTH;
489 cdnaLength -= CODON_LENGTH;
492 if (translatesAs(cdnaSeqChars, startOffset, aaSeqChars))
495 * protein is translation of dna (+/- start/stop codons)
497 MapList map = new MapList(new int[] { cdnaStart, cdnaEnd },
499 { proteinStart, proteinEnd }, CODON_LENGTH, 1);
504 * translation failed - try mapping CDS annotated regions of dna
506 return mapCdsToProtein(cdnaSeq, proteinSeq);
510 * Test whether the given cdna sequence, starting at the given offset,
511 * translates to the given amino acid sequence, using the standard translation
512 * table. Designed to fail fast i.e. as soon as a mismatch position is found.
514 * @param cdnaSeqChars
519 protected static boolean translatesAs(char[] cdnaSeqChars, int cdnaStart,
522 if (cdnaSeqChars == null || aaSeqChars == null)
528 int dnaPos = cdnaStart;
529 for (; dnaPos < cdnaSeqChars.length - 2
530 && aaPos < aaSeqChars.length; dnaPos += CODON_LENGTH, aaPos++)
532 String codon = String.valueOf(cdnaSeqChars, dnaPos, CODON_LENGTH);
533 final String translated = ResidueProperties.codonTranslate(codon);
536 * allow * in protein to match untranslatable in dna
538 final char aaRes = aaSeqChars[aaPos];
539 if ((translated == null || ResidueProperties.STOP.equals(translated))
544 if (translated == null || !(aaRes == translated.charAt(0)))
547 // System.out.println(("Mismatch at " + i + "/" + aaResidue + ": "
548 // + codon + "(" + translated + ") != " + aaRes));
554 * check we matched all of the protein sequence
556 if (aaPos != aaSeqChars.length)
562 * check we matched all of the dna except
563 * for optional trailing STOP codon
565 if (dnaPos == cdnaSeqChars.length)
569 if (dnaPos == cdnaSeqChars.length - CODON_LENGTH)
571 String codon = String.valueOf(cdnaSeqChars, dnaPos, CODON_LENGTH);
572 if (ResidueProperties.STOP
573 .equals(ResidueProperties.codonTranslate(codon)))
582 * Align sequence 'seq' to match the alignment of a mapped sequence. Note this
583 * currently assumes that we are aligning cDNA to match protein.
586 * the sequence to be realigned
588 * the alignment whose sequence alignment is to be 'copied'
590 * character string represent a gap in the realigned sequence
591 * @param preserveUnmappedGaps
592 * @param preserveMappedGaps
593 * @return true if the sequence was realigned, false if it could not be
595 public static boolean alignSequenceAs(SequenceI seq, AlignmentI al,
596 String gap, boolean preserveMappedGaps,
597 boolean preserveUnmappedGaps)
600 * Get any mappings from the source alignment to the target (dataset)
603 // TODO there may be one AlignedCodonFrame per dataset sequence, or one with
604 // all mappings. Would it help to constrain this?
605 List<AlignedCodonFrame> mappings = al.getCodonFrame(seq);
606 if (mappings == null || mappings.isEmpty())
612 * Locate the aligned source sequence whose dataset sequence is mapped. We
613 * just take the first match here (as we can't align like more than one
616 SequenceI alignFrom = null;
617 AlignedCodonFrame mapping = null;
618 for (AlignedCodonFrame mp : mappings)
620 alignFrom = mp.findAlignedSequence(seq, al);
621 if (alignFrom != null)
628 if (alignFrom == null)
632 alignSequenceAs(seq, alignFrom, mapping, gap, al.getGapCharacter(),
633 preserveMappedGaps, preserveUnmappedGaps);
638 * Align sequence 'alignTo' the same way as 'alignFrom', using the mapping to
639 * match residues and codons. Flags control whether existing gaps in unmapped
640 * (intron) and mapped (exon) regions are preserved or not. Gaps between
641 * intron and exon are only retained if both flags are set.
648 * @param preserveUnmappedGaps
649 * @param preserveMappedGaps
651 public static void alignSequenceAs(SequenceI alignTo, SequenceI alignFrom,
652 AlignedCodonFrame mapping, String myGap, char sourceGap,
653 boolean preserveMappedGaps, boolean preserveUnmappedGaps)
655 // TODO generalise to work for Protein-Protein, dna-dna, dna-protein
657 // aligned and dataset sequence positions, all base zero
661 int basesWritten = 0;
662 char myGapChar = myGap.charAt(0);
663 int ratio = myGap.length();
665 int fromOffset = alignFrom.getStart() - 1;
666 int toOffset = alignTo.getStart() - 1;
667 int sourceGapMappedLength = 0;
668 boolean inExon = false;
669 final int toLength = alignTo.getLength();
670 final int fromLength = alignFrom.getLength();
671 StringBuilder thisAligned = new StringBuilder(2 * toLength);
674 * Traverse the 'model' aligned sequence
676 for (int i = 0; i < fromLength; i++)
678 char sourceChar = alignFrom.getCharAt(i);
679 if (sourceChar == sourceGap)
681 sourceGapMappedLength += ratio;
686 * Found a non-gap character. Locate its mapped region if any.
689 // Note mapping positions are base 1, our sequence positions base 0
690 int[] mappedPos = mapping.getMappedRegion(alignTo, alignFrom,
691 sourceDsPos + fromOffset);
692 if (mappedPos == null)
695 * unmapped position; treat like a gap
697 sourceGapMappedLength += ratio;
698 // System.err.println("Can't align: no codon mapping to residue "
699 // + sourceDsPos + "(" + sourceChar + ")");
704 int mappedCodonStart = mappedPos[0]; // position (1...) of codon start
705 int mappedCodonEnd = mappedPos[mappedPos.length - 1]; // codon end pos
706 StringBuilder trailingCopiedGap = new StringBuilder();
709 * Copy dna sequence up to and including this codon. Optionally, include
710 * gaps before the codon starts (in introns) and/or after the codon starts
713 * Note this only works for 'linear' splicing, not reverse or interleaved.
714 * But then 'align dna as protein' doesn't make much sense otherwise.
716 int intronLength = 0;
717 while (basesWritten + toOffset < mappedCodonEnd
718 && thisSeqPos < toLength)
720 final char c = alignTo.getCharAt(thisSeqPos++);
724 int sourcePosition = basesWritten + toOffset;
725 if (sourcePosition < mappedCodonStart)
728 * Found an unmapped (intron) base. First add in any preceding gaps
731 if (preserveUnmappedGaps && trailingCopiedGap.length() > 0)
733 thisAligned.append(trailingCopiedGap.toString());
734 intronLength += trailingCopiedGap.length();
735 trailingCopiedGap = new StringBuilder();
742 final boolean startOfCodon = sourcePosition == mappedCodonStart;
743 int gapsToAdd = calculateGapsToInsert(preserveMappedGaps,
744 preserveUnmappedGaps, sourceGapMappedLength, inExon,
745 trailingCopiedGap.length(), intronLength, startOfCodon);
746 for (int k = 0; k < gapsToAdd; k++)
748 thisAligned.append(myGapChar);
750 sourceGapMappedLength = 0;
753 thisAligned.append(c);
754 trailingCopiedGap = new StringBuilder();
758 if (inExon && preserveMappedGaps)
760 trailingCopiedGap.append(myGapChar);
762 else if (!inExon && preserveUnmappedGaps)
764 trailingCopiedGap.append(myGapChar);
771 * At end of model aligned sequence. Copy any remaining target sequence, optionally
772 * including (intron) gaps.
774 while (thisSeqPos < toLength)
776 final char c = alignTo.getCharAt(thisSeqPos++);
777 if (c != myGapChar || preserveUnmappedGaps)
779 thisAligned.append(c);
781 sourceGapMappedLength--;
785 * finally add gaps to pad for any trailing source gaps or
786 * unmapped characters
788 if (preserveUnmappedGaps)
790 while (sourceGapMappedLength > 0)
792 thisAligned.append(myGapChar);
793 sourceGapMappedLength--;
798 * All done aligning, set the aligned sequence.
800 alignTo.setSequence(new String(thisAligned));
804 * Helper method to work out how many gaps to insert when realigning.
806 * @param preserveMappedGaps
807 * @param preserveUnmappedGaps
808 * @param sourceGapMappedLength
810 * @param trailingCopiedGap
811 * @param intronLength
812 * @param startOfCodon
815 protected static int calculateGapsToInsert(boolean preserveMappedGaps,
816 boolean preserveUnmappedGaps, int sourceGapMappedLength,
817 boolean inExon, int trailingGapLength, int intronLength,
818 final boolean startOfCodon)
824 * Reached start of codon. Ignore trailing gaps in intron unless we are
825 * preserving gaps in both exon and intron. Ignore them anyway if the
826 * protein alignment introduces a gap at least as large as the intronic
829 if (inExon && !preserveMappedGaps)
831 trailingGapLength = 0;
833 if (!inExon && !(preserveMappedGaps && preserveUnmappedGaps))
835 trailingGapLength = 0;
839 gapsToAdd = Math.max(sourceGapMappedLength, trailingGapLength);
843 if (intronLength + trailingGapLength <= sourceGapMappedLength)
845 gapsToAdd = sourceGapMappedLength - intronLength;
849 gapsToAdd = Math.min(
850 intronLength + trailingGapLength - sourceGapMappedLength,
858 * second or third base of codon; check for any gaps in dna
860 if (!preserveMappedGaps)
862 trailingGapLength = 0;
864 gapsToAdd = Math.max(sourceGapMappedLength, trailingGapLength);
870 * Realigns the given protein to match the alignment of the dna, using codon
871 * mappings to translate aligned codon positions to protein residues.
874 * the alignment whose sequences are realigned by this method
876 * the dna alignment whose alignment we are 'copying'
877 * @return the number of sequences that were realigned
879 public static int alignProteinAsDna(AlignmentI protein, AlignmentI dna)
881 if (protein.isNucleotide() || !dna.isNucleotide())
883 System.err.println("Wrong alignment type in alignProteinAsDna");
886 List<SequenceI> unmappedProtein = new ArrayList<>();
887 Map<AlignedCodon, Map<SequenceI, AlignedCodon>> alignedCodons = buildCodonColumnsMap(
888 protein, dna, unmappedProtein);
889 return alignProteinAs(protein, alignedCodons, unmappedProtein);
893 * Realigns the given dna to match the alignment of the protein, using codon
894 * mappings to translate aligned peptide positions to codons.
896 * Always produces a padded CDS alignment.
899 * the alignment whose sequences are realigned by this method
901 * the protein alignment whose alignment we are 'copying'
902 * @return the number of sequences that were realigned
904 public static int alignCdsAsProtein(AlignmentI dna, AlignmentI protein)
906 if (protein.isNucleotide() || !dna.isNucleotide())
908 System.err.println("Wrong alignment type in alignProteinAsDna");
911 // todo: implement this
912 List<AlignedCodonFrame> mappings = protein.getCodonFrames();
913 int alignedCount = 0;
914 int width = 0; // alignment width for padding CDS
915 for (SequenceI dnaSeq : dna.getSequences())
917 if (alignCdsSequenceAsProtein(dnaSeq, protein, mappings,
918 dna.getGapCharacter()))
922 width = Math.max(dnaSeq.getLength(), width);
926 for (SequenceI dnaSeq : dna.getSequences())
928 oldwidth = dnaSeq.getLength();
929 diff = width - oldwidth;
932 dnaSeq.insertCharAt(oldwidth, diff, dna.getGapCharacter());
939 * Helper method to align (if possible) the dna sequence to match the
940 * alignment of a mapped protein sequence. This is currently limited to
941 * handling coding sequence only.
949 static boolean alignCdsSequenceAsProtein(SequenceI cdsSeq,
950 AlignmentI protein, List<AlignedCodonFrame> mappings,
953 SequenceI cdsDss = cdsSeq.getDatasetSequence();
957 .println("alignCdsSequenceAsProtein needs aligned sequence!");
961 List<AlignedCodonFrame> dnaMappings = MappingUtils
962 .findMappingsForSequence(cdsSeq, mappings);
963 for (AlignedCodonFrame mapping : dnaMappings)
965 SequenceI peptide = mapping.findAlignedSequence(cdsSeq, protein);
968 final int peptideLength = peptide.getLength();
969 Mapping map = mapping.getMappingBetween(cdsSeq, peptide);
972 MapList mapList = map.getMap();
973 if (map.getTo() == peptide.getDatasetSequence())
975 mapList = mapList.getInverse();
977 final int cdsLength = cdsDss.getLength();
978 int mappedFromLength = MappingUtils.getLength(mapList
980 int mappedToLength = MappingUtils
981 .getLength(mapList.getToRanges());
982 boolean addStopCodon = (cdsLength == mappedFromLength
983 * CODON_LENGTH + CODON_LENGTH)
984 || (peptide.getDatasetSequence()
985 .getLength() == mappedFromLength - 1);
986 if (cdsLength != mappedToLength && !addStopCodon)
988 System.err.println(String.format(
989 "Can't align cds as protein (length mismatch %d/%d): %s",
990 cdsLength, mappedToLength, cdsSeq.getName()));
994 * pre-fill the aligned cds sequence with gaps
996 char[] alignedCds = new char[peptideLength * CODON_LENGTH
997 + (addStopCodon ? CODON_LENGTH : 0)];
998 Arrays.fill(alignedCds, gapChar);
1001 * walk over the aligned peptide sequence and insert mapped
1002 * codons for residues in the aligned cds sequence
1004 int copiedBases = 0;
1005 int cdsStart = cdsDss.getStart();
1006 int proteinPos = peptide.getStart() - 1;
1009 for (int col = 0; col < peptideLength; col++)
1011 char residue = peptide.getCharAt(col);
1013 if (Comparison.isGap(residue))
1015 cdsCol += CODON_LENGTH;
1020 int[] codon = mapList.locateInTo(proteinPos, proteinPos);
1023 // e.g. incomplete start codon, X in peptide
1024 cdsCol += CODON_LENGTH;
1028 for (int j = codon[0]; j <= codon[1]; j++)
1030 char mappedBase = cdsDss.getCharAt(j - cdsStart);
1031 alignedCds[cdsCol++] = mappedBase;
1039 * append stop codon if not mapped from protein,
1040 * closing it up to the end of the mapped sequence
1042 if (copiedBases == cdsLength - CODON_LENGTH)
1044 for (int i = alignedCds.length - 1; i >= 0; i--)
1046 if (!Comparison.isGap(alignedCds[i]))
1048 cdsCol = i + 1; // gap just after end of sequence
1052 for (int i = cdsLength - CODON_LENGTH; i < cdsLength; i++)
1054 alignedCds[cdsCol++] = cdsDss.getCharAt(i);
1057 cdsSeq.setSequence(new String(alignedCds));
1066 * Builds a map whose key is an aligned codon position (3 alignment column
1067 * numbers base 0), and whose value is a map from protein sequence to each
1068 * protein's peptide residue for that codon. The map generates an ordering of
1069 * the codons, and allows us to read off the peptides at each position in
1070 * order to assemble 'aligned' protein sequences.
1073 * the protein alignment
1075 * the coding dna alignment
1076 * @param unmappedProtein
1077 * any unmapped proteins are added to this list
1080 protected static Map<AlignedCodon, Map<SequenceI, AlignedCodon>> buildCodonColumnsMap(
1081 AlignmentI protein, AlignmentI dna,
1082 List<SequenceI> unmappedProtein)
1085 * maintain a list of any proteins with no mappings - these will be
1086 * rendered 'as is' in the protein alignment as we can't align them
1088 unmappedProtein.addAll(protein.getSequences());
1090 List<AlignedCodonFrame> mappings = protein.getCodonFrames();
1093 * Map will hold, for each aligned codon position e.g. [3, 5, 6], a map of
1094 * {dnaSequence, {proteinSequence, codonProduct}} at that position. The
1095 * comparator keeps the codon positions ordered.
1097 Map<AlignedCodon, Map<SequenceI, AlignedCodon>> alignedCodons = new TreeMap<>(
1098 new CodonComparator());
1100 for (SequenceI dnaSeq : dna.getSequences())
1102 for (AlignedCodonFrame mapping : mappings)
1104 SequenceI prot = mapping.findAlignedSequence(dnaSeq, protein);
1107 Mapping seqMap = mapping.getMappingForSequence(dnaSeq);
1108 addCodonPositions(dnaSeq, prot, protein.getGapCharacter(), seqMap,
1110 unmappedProtein.remove(prot);
1116 * Finally add any unmapped peptide start residues (e.g. for incomplete
1117 * codons) as if at the codon position before the second residue
1119 // TODO resolve JAL-2022 so this fudge can be removed
1120 int mappedSequenceCount = protein.getHeight() - unmappedProtein.size();
1121 addUnmappedPeptideStarts(alignedCodons, mappedSequenceCount);
1123 return alignedCodons;
1127 * Scans for any protein mapped from position 2 (meaning unmapped start
1128 * position e.g. an incomplete codon), and synthesizes a 'codon' for it at the
1129 * preceding position in the alignment
1131 * @param alignedCodons
1132 * the codon-to-peptide map
1133 * @param mappedSequenceCount
1134 * the number of distinct sequences in the map
1136 protected static void addUnmappedPeptideStarts(
1137 Map<AlignedCodon, Map<SequenceI, AlignedCodon>> alignedCodons,
1138 int mappedSequenceCount)
1140 // TODO delete this ugly hack once JAL-2022 is resolved
1141 // i.e. we can model startPhase > 0 (incomplete start codon)
1143 List<SequenceI> sequencesChecked = new ArrayList<>();
1144 AlignedCodon lastCodon = null;
1145 Map<SequenceI, AlignedCodon> toAdd = new HashMap<>();
1147 for (Entry<AlignedCodon, Map<SequenceI, AlignedCodon>> entry : alignedCodons
1150 for (Entry<SequenceI, AlignedCodon> sequenceCodon : entry.getValue()
1153 SequenceI seq = sequenceCodon.getKey();
1154 if (sequencesChecked.contains(seq))
1158 sequencesChecked.add(seq);
1159 AlignedCodon codon = sequenceCodon.getValue();
1160 if (codon.peptideCol > 1)
1163 "Problem mapping protein with >1 unmapped start positions: "
1166 else if (codon.peptideCol == 1)
1169 * first position (peptideCol == 0) was unmapped - add it
1171 if (lastCodon != null)
1173 AlignedCodon firstPeptide = new AlignedCodon(lastCodon.pos1,
1174 lastCodon.pos2, lastCodon.pos3,
1175 String.valueOf(seq.getCharAt(0)), 0);
1176 toAdd.put(seq, firstPeptide);
1181 * unmapped residue at start of alignment (no prior column) -
1182 * 'insert' at nominal codon [0, 0, 0]
1184 AlignedCodon firstPeptide = new AlignedCodon(0, 0, 0,
1185 String.valueOf(seq.getCharAt(0)), 0);
1186 toAdd.put(seq, firstPeptide);
1189 if (sequencesChecked.size() == mappedSequenceCount)
1191 // no need to check past first mapped position in all sequences
1195 lastCodon = entry.getKey();
1199 * add any new codons safely after iterating over the map
1201 for (Entry<SequenceI, AlignedCodon> startCodon : toAdd.entrySet())
1203 addCodonToMap(alignedCodons, startCodon.getValue(),
1204 startCodon.getKey());
1209 * Update the aligned protein sequences to match the codon alignments given in
1213 * @param alignedCodons
1214 * an ordered map of codon positions (columns), with sequence/peptide
1215 * values present in each column
1216 * @param unmappedProtein
1219 protected static int alignProteinAs(AlignmentI protein,
1220 Map<AlignedCodon, Map<SequenceI, AlignedCodon>> alignedCodons,
1221 List<SequenceI> unmappedProtein)
1224 * prefill peptide sequences with gaps
1226 int alignedWidth = alignedCodons.size();
1227 char[] gaps = new char[alignedWidth];
1228 Arrays.fill(gaps, protein.getGapCharacter());
1229 Map<SequenceI, char[]> peptides = new HashMap<>();
1230 for (SequenceI seq : protein.getSequences())
1232 if (!unmappedProtein.contains(seq))
1234 peptides.put(seq, Arrays.copyOf(gaps, gaps.length));
1239 * Traverse the codons left to right (as defined by CodonComparator)
1240 * and insert peptides in each column where the sequence is mapped.
1241 * This gives a peptide 'alignment' where residues are aligned if their
1242 * corresponding codons occupy the same columns in the cdna alignment.
1245 for (AlignedCodon codon : alignedCodons.keySet())
1247 final Map<SequenceI, AlignedCodon> columnResidues = alignedCodons
1249 for (Entry<SequenceI, AlignedCodon> entry : columnResidues.entrySet())
1251 char residue = entry.getValue().product.charAt(0);
1252 peptides.get(entry.getKey())[column] = residue;
1258 * and finally set the constructed sequences
1260 for (Entry<SequenceI, char[]> entry : peptides.entrySet())
1262 entry.getKey().setSequence(new String(entry.getValue()));
1269 * Populate the map of aligned codons by traversing the given sequence
1270 * mapping, locating the aligned positions of mapped codons, and adding those
1271 * positions and their translation products to the map.
1274 * the aligned sequence we are mapping from
1276 * the sequence to be aligned to the codons
1278 * the gap character in the dna sequence
1280 * a mapping to a sequence translation
1281 * @param alignedCodons
1282 * the map we are building up
1284 static void addCodonPositions(SequenceI dna, SequenceI protein,
1285 char gapChar, Mapping seqMap,
1286 Map<AlignedCodon, Map<SequenceI, AlignedCodon>> alignedCodons)
1288 Iterator<AlignedCodon> codons = seqMap.getCodonIterator(dna, gapChar);
1291 * add codon positions, and their peptide translations, to the alignment
1292 * map, while remembering the first codon mapped
1294 while (codons.hasNext())
1298 AlignedCodon codon = codons.next();
1299 addCodonToMap(alignedCodons, codon, protein);
1300 } catch (IncompleteCodonException e)
1302 // possible incomplete trailing codon - ignore
1303 } catch (NoSuchElementException e)
1305 // possibly peptide lacking STOP
1311 * Helper method to add a codon-to-peptide entry to the aligned codons map
1313 * @param alignedCodons
1317 protected static void addCodonToMap(
1318 Map<AlignedCodon, Map<SequenceI, AlignedCodon>> alignedCodons,
1319 AlignedCodon codon, SequenceI protein)
1321 Map<SequenceI, AlignedCodon> seqProduct = alignedCodons.get(codon);
1322 if (seqProduct == null)
1324 seqProduct = new HashMap<>();
1325 alignedCodons.put(codon, seqProduct);
1327 seqProduct.put(protein, codon);
1331 * Returns true if a cDNA/Protein mapping either exists, or could be made,
1332 * between at least one pair of sequences in the two alignments. Currently,
1335 * <li>One alignment must be nucleotide, and the other protein</li>
1336 * <li>At least one pair of sequences must be already mapped, or mappable</li>
1337 * <li>Mappable means the nucleotide translation matches the protein
1339 * <li>The translation may ignore start and stop codons if present in the
1347 public static boolean isMappable(AlignmentI al1, AlignmentI al2)
1349 if (al1 == null || al2 == null)
1355 * Require one nucleotide and one protein
1357 if (al1.isNucleotide() == al2.isNucleotide())
1361 AlignmentI dna = al1.isNucleotide() ? al1 : al2;
1362 AlignmentI protein = dna == al1 ? al2 : al1;
1363 List<AlignedCodonFrame> mappings = protein.getCodonFrames();
1364 for (SequenceI dnaSeq : dna.getSequences())
1366 for (SequenceI proteinSeq : protein.getSequences())
1368 if (isMappable(dnaSeq, proteinSeq, mappings))
1378 * Returns true if the dna sequence is mapped, or could be mapped, to the
1386 protected static boolean isMappable(SequenceI dnaSeq,
1387 SequenceI proteinSeq, List<AlignedCodonFrame> mappings)
1389 if (dnaSeq == null || proteinSeq == null)
1394 SequenceI dnaDs = dnaSeq.getDatasetSequence() == null ? dnaSeq
1395 : dnaSeq.getDatasetSequence();
1396 SequenceI proteinDs = proteinSeq.getDatasetSequence() == null
1398 : proteinSeq.getDatasetSequence();
1400 for (AlignedCodonFrame mapping : mappings)
1402 if (proteinDs == mapping.getAaForDnaSeq(dnaDs))
1412 * Just try to make a mapping (it is not yet stored), test whether
1415 return mapCdnaToProtein(proteinDs, dnaDs) != null;
1419 * Finds any reference annotations associated with the sequences in
1420 * sequenceScope, that are not already added to the alignment, and adds them
1421 * to the 'candidates' map. Also populates a lookup table of annotation
1422 * labels, keyed by calcId, for use in constructing tooltips or the like.
1424 * @param sequenceScope
1425 * the sequences to scan for reference annotations
1426 * @param labelForCalcId
1427 * (optional) map to populate with label for calcId
1429 * map to populate with annotations for sequence
1431 * the alignment to check for presence of annotations
1433 public static void findAddableReferenceAnnotations(
1434 List<SequenceI> sequenceScope, Map<String, String> labelForCalcId,
1435 final Map<SequenceI, List<AlignmentAnnotation>> candidates,
1438 if (sequenceScope == null)
1444 * For each sequence in scope, make a list of any annotations on the
1445 * underlying dataset sequence which are not already on the alignment.
1447 * Add to a map of { alignmentSequence, <List of annotations to add> }
1449 for (SequenceI seq : sequenceScope)
1451 SequenceI dataset = seq.getDatasetSequence();
1452 if (dataset == null)
1456 AlignmentAnnotation[] datasetAnnotations = dataset.getAnnotation();
1457 if (datasetAnnotations == null)
1461 final List<AlignmentAnnotation> result = new ArrayList<>();
1462 for (AlignmentAnnotation dsann : datasetAnnotations)
1465 * Find matching annotations on the alignment. If none is found, then
1466 * add this annotation to the list of 'addable' annotations for this
1469 final Iterable<AlignmentAnnotation> matchedAlignmentAnnotations = al
1470 .findAnnotations(seq, dsann.getCalcId(), dsann.label);
1471 if (!matchedAlignmentAnnotations.iterator().hasNext())
1474 if (labelForCalcId != null)
1476 labelForCalcId.put(dsann.getCalcId(), dsann.label);
1481 * Save any addable annotations for this sequence
1483 if (!result.isEmpty())
1485 candidates.put(seq, result);
1491 * Adds annotations to the top of the alignment annotations, in the same order
1492 * as their related sequences.
1494 * @param annotations
1495 * the annotations to add
1497 * the alignment to add them to
1498 * @param selectionGroup
1499 * current selection group (or null if none)
1501 public static void addReferenceAnnotations(
1502 Map<SequenceI, List<AlignmentAnnotation>> annotations,
1503 final AlignmentI alignment, final SequenceGroup selectionGroup)
1505 for (SequenceI seq : annotations.keySet())
1507 for (AlignmentAnnotation ann : annotations.get(seq))
1509 AlignmentAnnotation copyAnn = new AlignmentAnnotation(ann);
1511 int endRes = ann.annotations.length;
1512 if (selectionGroup != null)
1514 startRes = selectionGroup.getStartRes();
1515 endRes = selectionGroup.getEndRes();
1517 copyAnn.restrict(startRes, endRes);
1520 * Add to the sequence (sets copyAnn.datasetSequence), unless the
1521 * original annotation is already on the sequence.
1523 if (!seq.hasAnnotation(ann))
1525 seq.addAlignmentAnnotation(copyAnn);
1528 copyAnn.adjustForAlignment();
1529 // add to the alignment and set visible
1530 alignment.addAnnotation(copyAnn);
1531 copyAnn.visible = true;
1537 * Set visibility of alignment annotations of specified types (labels), for
1538 * specified sequences. This supports controls like "Show all secondary
1539 * structure", "Hide all Temp factor", etc.
1541 * @al the alignment to scan for annotations
1543 * the types (labels) of annotations to be updated
1544 * @param forSequences
1545 * if not null, only annotations linked to one of these sequences are
1546 * in scope for update; if null, acts on all sequence annotations
1548 * if this flag is true, 'types' is ignored (label not checked)
1550 * if true, set visibility on, else set off
1552 public static void showOrHideSequenceAnnotations(AlignmentI al,
1553 Collection<String> types, List<SequenceI> forSequences,
1554 boolean anyType, boolean doShow)
1556 AlignmentAnnotation[] anns = al.getAlignmentAnnotation();
1559 for (AlignmentAnnotation aa : anns)
1561 if (anyType || types.contains(aa.label))
1563 if ((aa.sequenceRef != null) && (forSequences == null
1564 || forSequences.contains(aa.sequenceRef)))
1566 aa.visible = doShow;
1574 * Returns true if either sequence has a cross-reference to the other
1580 public static boolean haveCrossRef(SequenceI seq1, SequenceI seq2)
1582 // Note: moved here from class CrossRef as the latter class has dependencies
1583 // not availability to the applet's classpath
1584 return hasCrossRef(seq1, seq2) || hasCrossRef(seq2, seq1);
1588 * Returns true if seq1 has a cross-reference to seq2. Currently this assumes
1589 * that sequence name is structured as Source|AccessionId.
1595 public static boolean hasCrossRef(SequenceI seq1, SequenceI seq2)
1597 if (seq1 == null || seq2 == null)
1601 String name = seq2.getName();
1602 final List<DBRefEntry> xrefs = seq1.getDBRefs();
1605 for (int ix = 0, nx = xrefs.size(); ix < nx; ix++)
1607 DBRefEntry xref = xrefs.get(ix);
1608 String xrefName = xref.getSource() + "|" + xref.getAccessionId();
1609 // case-insensitive test, consistent with DBRefEntry.equalRef()
1610 if (xrefName.equalsIgnoreCase(name))
1620 * Constructs an alignment consisting of the mapped (CDS) regions in the given
1621 * nucleotide sequences, and updates mappings to match. The CDS sequences are
1622 * added to the original alignment's dataset, which is shared by the new
1623 * alignment. Mappings from nucleotide to CDS, and from CDS to protein, are
1624 * added to the alignment dataset.
1627 * aligned nucleotide (dna or cds) sequences
1629 * the alignment dataset the sequences belong to
1631 * (optional) to restrict results to CDS that map to specified
1633 * @return an alignment whose sequences are the cds-only parts of the dna
1634 * sequences (or null if no mappings are found)
1636 public static AlignmentI makeCdsAlignment(SequenceI[] dna,
1637 AlignmentI dataset, SequenceI[] products)
1639 if (dataset == null || dataset.getDataset() != null)
1641 throw new IllegalArgumentException(
1642 "IMPLEMENTATION ERROR: dataset.getDataset() must be null!");
1644 List<SequenceI> foundSeqs = new ArrayList<>();
1645 List<SequenceI> cdsSeqs = new ArrayList<>();
1646 List<AlignedCodonFrame> mappings = dataset.getCodonFrames();
1647 HashSet<SequenceI> productSeqs = null;
1648 if (products != null)
1650 productSeqs = new HashSet<>();
1651 for (SequenceI seq : products)
1653 productSeqs.add(seq.getDatasetSequence() == null ? seq : seq
1654 .getDatasetSequence());
1659 * Construct CDS sequences from mappings on the alignment dataset.
1661 * - find the protein product(s) mapped to from each dna sequence
1662 * - if the mapping covers the whole dna sequence (give or take start/stop
1663 * codon), take the dna as the CDS sequence
1664 * - else search dataset mappings for a suitable dna sequence, i.e. one
1665 * whose whole sequence is mapped to the protein
1666 * - if no sequence found, construct one from the dna sequence and mapping
1667 * (and add it to dataset so it is found if this is repeated)
1669 for (SequenceI dnaSeq : dna)
1671 SequenceI dnaDss = dnaSeq.getDatasetSequence() == null ? dnaSeq
1672 : dnaSeq.getDatasetSequence();
1674 List<AlignedCodonFrame> seqMappings = MappingUtils
1675 .findMappingsForSequence(dnaSeq, mappings);
1676 for (AlignedCodonFrame mapping : seqMappings)
1678 List<Mapping> mappingsFromSequence = mapping
1679 .getMappingsFromSequence(dnaSeq);
1681 for (Mapping aMapping : mappingsFromSequence)
1683 MapList mapList = aMapping.getMap();
1684 if (mapList.getFromRatio() == 1)
1687 * not a dna-to-protein mapping (likely dna-to-cds)
1693 * skip if mapping is not to one of the target set of proteins
1695 SequenceI proteinProduct = aMapping.getTo();
1696 if (productSeqs != null && !productSeqs.contains(proteinProduct))
1702 * try to locate the CDS from the dataset mappings;
1703 * guard against duplicate results (for the case that protein has
1704 * dbrefs to both dna and cds sequences)
1706 SequenceI cdsSeq = findCdsForProtein(mappings, dnaSeq,
1707 seqMappings, aMapping);
1710 if (!foundSeqs.contains(cdsSeq))
1712 foundSeqs.add(cdsSeq);
1713 SequenceI derivedSequence = cdsSeq.deriveSequence();
1714 cdsSeqs.add(derivedSequence);
1715 if (!dataset.getSequences().contains(cdsSeq))
1717 dataset.addSequence(cdsSeq);
1724 * didn't find mapped CDS sequence - construct it and add
1725 * its dataset sequence to the dataset
1727 cdsSeq = makeCdsSequence(dnaSeq.getDatasetSequence(), aMapping,
1728 dataset).deriveSequence();
1729 // cdsSeq has a name constructed as CDS|<dbref>
1730 // <dbref> will be either the accession for the coding sequence,
1731 // marked in the /via/ dbref to the protein product accession
1732 // or it will be the original nucleotide accession.
1733 SequenceI cdsSeqDss = cdsSeq.getDatasetSequence();
1735 cdsSeqs.add(cdsSeq);
1738 * build the mapping from CDS to protein
1740 List<int[]> cdsRange = Collections
1741 .singletonList(new int[]
1742 { cdsSeq.getStart(),
1743 cdsSeq.getLength() + cdsSeq.getStart() - 1 });
1744 MapList cdsToProteinMap = new MapList(cdsRange,
1745 mapList.getToRanges(), mapList.getFromRatio(),
1746 mapList.getToRatio());
1748 if (!dataset.getSequences().contains(cdsSeqDss))
1751 * if this sequence is a newly created one, add it to the dataset
1752 * and made a CDS to protein mapping (if sequence already exists,
1753 * CDS-to-protein mapping _is_ the transcript-to-protein mapping)
1755 dataset.addSequence(cdsSeqDss);
1756 AlignedCodonFrame cdsToProteinMapping = new AlignedCodonFrame();
1757 cdsToProteinMapping.addMap(cdsSeqDss, proteinProduct,
1761 * guard against duplicating the mapping if repeating this action
1763 if (!mappings.contains(cdsToProteinMapping))
1765 mappings.add(cdsToProteinMapping);
1769 propagateDBRefsToCDS(cdsSeqDss, dnaSeq.getDatasetSequence(),
1770 proteinProduct, aMapping);
1772 * add another mapping from original 'from' range to CDS
1774 AlignedCodonFrame dnaToCdsMapping = new AlignedCodonFrame();
1775 final MapList dnaToCdsMap = new MapList(mapList.getFromRanges(),
1777 dnaToCdsMapping.addMap(dnaSeq.getDatasetSequence(), cdsSeqDss,
1779 if (!mappings.contains(dnaToCdsMapping))
1781 mappings.add(dnaToCdsMapping);
1785 * transfer dna chromosomal loci (if known) to the CDS
1786 * sequence (via the mapping)
1788 final MapList cdsToDnaMap = dnaToCdsMap.getInverse();
1789 transferGeneLoci(dnaSeq, cdsToDnaMap, cdsSeq);
1792 * add DBRef with mapping from protein to CDS
1793 * (this enables Get Cross-References from protein alignment)
1794 * This is tricky because we can't have two DBRefs with the
1795 * same source and accession, so need a different accession for
1796 * the CDS from the dna sequence
1799 // specific use case:
1800 // Genomic contig ENSCHR:1, contains coding regions for ENSG01,
1801 // ENSG02, ENSG03, with transcripts and products similarly named.
1802 // cannot add distinct dbrefs mapping location on ENSCHR:1 to ENSG01
1804 // JBPNote: ?? can't actually create an example that demonstrates we
1806 // synthesize an xref.
1808 List<DBRefEntry> primrefs = dnaDss.getPrimaryDBRefs();
1809 for (int ip = 0, np = primrefs.size(); ip < np; ip++)
1811 DBRefEntry primRef = primrefs.get(ip);
1813 * create a cross-reference from CDS to the source sequence's
1814 * primary reference and vice versa
1816 String source = primRef.getSource();
1817 String version = primRef.getVersion();
1818 DBRefEntry cdsCrossRef = new DBRefEntry(source, source + ":"
1819 + version, primRef.getAccessionId());
1820 cdsCrossRef.setMap(new Mapping(dnaDss, new MapList(cdsToDnaMap)));
1821 cdsSeqDss.addDBRef(cdsCrossRef);
1823 dnaSeq.addDBRef(new DBRefEntry(source, version, cdsSeq
1824 .getName(), new Mapping(cdsSeqDss, dnaToCdsMap)));
1825 // problem here is that the cross-reference is synthesized -
1826 // cdsSeq.getName() may be like 'CDS|dnaaccession' or
1828 // assuming cds version same as dna ?!?
1830 DBRefEntry proteinToCdsRef = new DBRefEntry(source, version,
1833 proteinToCdsRef.setMap(new Mapping(cdsSeqDss, cdsToProteinMap
1835 proteinProduct.addDBRef(proteinToCdsRef);
1838 * transfer any features on dna that overlap the CDS
1840 transferFeatures(dnaSeq, cdsSeq, dnaToCdsMap, null,
1841 SequenceOntologyI.CDS);
1846 AlignmentI cds = new Alignment(cdsSeqs.toArray(new SequenceI[cdsSeqs
1848 cds.setDataset(dataset);
1854 * Tries to transfer gene loci (dbref to chromosome positions) from fromSeq to
1855 * toSeq, mediated by the given mapping between the sequences
1858 * @param targetToFrom
1862 protected static void transferGeneLoci(SequenceI fromSeq,
1863 MapList targetToFrom, SequenceI targetSeq)
1865 if (targetSeq.getGeneLoci() != null)
1867 // already have - don't override
1870 GeneLociI fromLoci = fromSeq.getGeneLoci();
1871 if (fromLoci == null)
1876 MapList newMap = targetToFrom.traverse(fromLoci.getMapping());
1880 targetSeq.setGeneLoci(fromLoci.getSpeciesId(),
1881 fromLoci.getAssemblyId(), fromLoci.getChromosomeId(), newMap);
1886 * A helper method that finds a CDS sequence in the alignment dataset that is
1887 * mapped to the given protein sequence, and either is, or has a mapping from,
1888 * the given dna sequence.
1891 * set of all mappings on the dataset
1893 * a dna (or cds) sequence we are searching from
1894 * @param seqMappings
1895 * the set of mappings involving dnaSeq
1897 * a transcript-to-peptide mapping
1900 static SequenceI findCdsForProtein(List<AlignedCodonFrame> mappings,
1901 SequenceI dnaSeq, List<AlignedCodonFrame> seqMappings,
1905 * TODO a better dna-cds-protein mapping data representation to allow easy
1906 * navigation; until then this clunky looping around lists of mappings
1908 SequenceI seqDss = dnaSeq.getDatasetSequence() == null ? dnaSeq
1909 : dnaSeq.getDatasetSequence();
1910 SequenceI proteinProduct = aMapping.getTo();
1913 * is this mapping from the whole dna sequence (i.e. CDS)?
1914 * allowing for possible stop codon on dna but not peptide
1916 int mappedFromLength = MappingUtils
1917 .getLength(aMapping.getMap().getFromRanges());
1918 int dnaLength = seqDss.getLength();
1919 if (mappedFromLength == dnaLength
1920 || mappedFromLength == dnaLength - CODON_LENGTH)
1923 * if sequence has CDS features, this is a transcript with no UTR
1924 * - do not take this as the CDS sequence! (JAL-2789)
1926 if (seqDss.getFeatures().getFeaturesByOntology(SequenceOntologyI.CDS)
1934 * looks like we found the dna-to-protein mapping; search for the
1935 * corresponding cds-to-protein mapping
1937 List<AlignedCodonFrame> mappingsToPeptide = MappingUtils
1938 .findMappingsForSequence(proteinProduct, mappings);
1939 for (AlignedCodonFrame acf : mappingsToPeptide)
1941 for (SequenceToSequenceMapping map : acf.getMappings())
1943 Mapping mapping = map.getMapping();
1944 if (mapping != aMapping
1945 && mapping.getMap().getFromRatio() == CODON_LENGTH
1946 && proteinProduct == mapping.getTo()
1947 && seqDss != map.getFromSeq())
1949 mappedFromLength = MappingUtils
1950 .getLength(mapping.getMap().getFromRanges());
1951 if (mappedFromLength == map.getFromSeq().getLength())
1954 * found a 3:1 mapping to the protein product which covers
1955 * the whole dna sequence i.e. is from CDS; finally check the CDS
1956 * is mapped from the given dna start sequence
1958 SequenceI cdsSeq = map.getFromSeq();
1959 // todo this test is weak if seqMappings contains multiple mappings;
1960 // we get away with it if transcript:cds relationship is 1:1
1961 List<AlignedCodonFrame> dnaToCdsMaps = MappingUtils
1962 .findMappingsForSequence(cdsSeq, seqMappings);
1963 if (!dnaToCdsMaps.isEmpty())
1975 * Helper method that makes a CDS sequence as defined by the mappings from the
1976 * given sequence i.e. extracts the 'mapped from' ranges (which may be on
1977 * forward or reverse strand).
1982 * - existing dataset. We check for sequences that look like the CDS
1983 * we are about to construct, if one exists already, then we will
1984 * just return that one.
1985 * @return CDS sequence (as a dataset sequence)
1987 static SequenceI makeCdsSequence(SequenceI seq, Mapping mapping,
1991 * construct CDS sequence name as "CDS|" with 'from id' held in the mapping
1992 * if set (e.g. EMBL protein_id), else sequence name appended
1994 String mapFromId = mapping.getMappedFromId();
1995 final String seqId = "CDS|"
1996 + (mapFromId != null ? mapFromId : seq.getName());
1998 SequenceI newSeq = null;
2000 final MapList maplist = mapping.getMap();
2001 if (maplist.isContiguous() && maplist.isFromForwardStrand())
2004 * just a subsequence, keep same dataset sequence
2006 int start = maplist.getFromLowest();
2007 int end = maplist.getFromHighest();
2008 newSeq = seq.getSubSequence(start - 1, end);
2009 newSeq.setName(seqId);
2014 * construct by splicing mapped from ranges
2016 char[] seqChars = seq.getSequence();
2017 List<int[]> fromRanges = maplist.getFromRanges();
2018 int cdsWidth = MappingUtils.getLength(fromRanges);
2019 char[] newSeqChars = new char[cdsWidth];
2022 for (int[] range : fromRanges)
2024 if (range[0] <= range[1])
2026 // forward strand mapping - just copy the range
2027 int length = range[1] - range[0] + 1;
2028 System.arraycopy(seqChars, range[0] - 1, newSeqChars, newPos,
2034 // reverse strand mapping - copy and complement one by one
2035 for (int i = range[0]; i >= range[1]; i--)
2037 newSeqChars[newPos++] = Dna.getComplement(seqChars[i - 1]);
2042 newSeq = new Sequence(seqId, newSeqChars, 1, newPos);
2045 if (dataset != null)
2047 SequenceI[] matches = dataset.findSequenceMatch(newSeq.getName());
2048 if (matches != null)
2050 boolean matched = false;
2051 for (SequenceI mtch : matches)
2053 if (mtch.getStart() != newSeq.getStart())
2057 if (mtch.getEnd() != newSeq.getEnd())
2061 if (!Arrays.equals(mtch.getSequence(), newSeq.getSequence()))
2073 "JAL-2154 regression: warning - found (and ignnored a duplicate CDS sequence):"
2079 // newSeq.setDescription(mapFromId);
2085 * Adds any DBRefEntrys to cdsSeq from contig that have a Mapping congruent to
2086 * the given mapping.
2090 * @param proteinProduct
2092 * @return list of DBRefEntrys added
2094 protected static List<DBRefEntry> propagateDBRefsToCDS(SequenceI cdsSeq,
2095 SequenceI contig, SequenceI proteinProduct, Mapping mapping)
2098 // gather direct refs from contig congruent with mapping
2099 List<DBRefEntry> direct = new ArrayList<>();
2100 HashSet<String> directSources = new HashSet<>();
2102 List<DBRefEntry> refs = contig.getDBRefs();
2105 for (int ib = 0, nb = refs.size(); ib < nb; ib++)
2107 DBRefEntry dbr = refs.get(ib);
2109 if (dbr.hasMap() && (map = dbr.getMap().getMap()).isTripletMap())
2111 // check if map is the CDS mapping
2112 if (mapping.getMap().equals(map))
2115 directSources.add(dbr.getSource());
2120 List<DBRefEntry> onSource = DBRefUtils.selectRefs(
2121 proteinProduct.getDBRefs(),
2122 directSources.toArray(new String[0]));
2123 List<DBRefEntry> propagated = new ArrayList<>();
2125 // and generate appropriate mappings
2126 for (int ic = 0, nc = direct.size(); ic < nc; ic++)
2128 DBRefEntry cdsref = direct.get(ic);
2129 Mapping m = cdsref.getMap();
2130 // clone maplist and mapping
2131 MapList cdsposmap = new MapList(
2132 Arrays.asList(new int[][]
2133 { new int[] { cdsSeq.getStart(), cdsSeq.getEnd() } }),
2134 m.getMap().getToRanges(), 3, 1);
2135 Mapping cdsmap = new Mapping(m.getTo(), m.getMap());
2138 DBRefEntry newref = new DBRefEntry(cdsref.getSource(),
2139 cdsref.getVersion(), cdsref.getAccessionId(),
2140 new Mapping(cdsmap.getTo(), cdsposmap));
2142 // and see if we can map to the protein product for this mapping.
2143 // onSource is the filtered set of accessions on protein that we are
2144 // tranferring, so we assume accession is the same.
2145 if (cdsmap.getTo() == null && onSource != null)
2147 List<DBRefEntry> sourceRefs = DBRefUtils.searchRefs(onSource,
2148 cdsref.getAccessionId());
2149 if (sourceRefs != null)
2151 for (DBRefEntry srcref : sourceRefs)
2153 if (srcref.getSource().equalsIgnoreCase(cdsref.getSource()))
2155 // we have found a complementary dbref on the protein product, so
2156 // update mapping's getTo
2157 newref.getMap().setTo(proteinProduct);
2162 cdsSeq.addDBRef(newref);
2163 propagated.add(newref);
2169 * Transfers co-located features on 'fromSeq' to 'toSeq', adjusting the
2170 * feature start/end ranges, optionally omitting specified feature types.
2171 * Returns the number of features copied.
2176 * the mapping from 'fromSeq' to 'toSeq'
2178 * if not null, only features of this type are copied (including
2179 * subtypes in the Sequence Ontology)
2182 protected static int transferFeatures(SequenceI fromSeq, SequenceI toSeq,
2183 MapList mapping, String select, String... omitting)
2185 SequenceI copyTo = toSeq;
2186 while (copyTo.getDatasetSequence() != null)
2188 copyTo = copyTo.getDatasetSequence();
2190 if (fromSeq == copyTo || fromSeq.getDatasetSequence() == copyTo)
2192 return 0; // shared dataset sequence
2196 * get features, optionally restricted by an ontology term
2198 List<SequenceFeature> sfs = select == null ? fromSeq.getFeatures()
2199 .getPositionalFeatures() : fromSeq.getFeatures()
2200 .getFeaturesByOntology(select);
2203 for (SequenceFeature sf : sfs)
2205 String type = sf.getType();
2206 boolean omit = false;
2207 for (String toOmit : omitting)
2209 if (type.equals(toOmit))
2220 * locate the mapped range - null if either start or end is
2221 * not mapped (no partial overlaps are calculated)
2223 int start = sf.getBegin();
2224 int end = sf.getEnd();
2225 int[] mappedTo = mapping.locateInTo(start, end);
2227 * if whole exon range doesn't map, try interpreting it
2228 * as 5' or 3' exon overlapping the CDS range
2230 if (mappedTo == null)
2232 mappedTo = mapping.locateInTo(end, end);
2233 if (mappedTo != null)
2236 * end of exon is in CDS range - 5' overlap
2237 * to a range from the start of the peptide
2242 if (mappedTo == null)
2244 mappedTo = mapping.locateInTo(start, start);
2245 if (mappedTo != null)
2248 * start of exon is in CDS range - 3' overlap
2249 * to a range up to the end of the peptide
2251 mappedTo[1] = toSeq.getLength();
2254 if (mappedTo != null)
2256 int newBegin = Math.min(mappedTo[0], mappedTo[1]);
2257 int newEnd = Math.max(mappedTo[0], mappedTo[1]);
2258 SequenceFeature copy = new SequenceFeature(sf, newBegin, newEnd,
2259 sf.getFeatureGroup(), sf.getScore());
2260 copyTo.addSequenceFeature(copy);
2268 * Returns a mapping from dna to protein by inspecting sequence features of
2269 * type "CDS" on the dna. A mapping is constructed if the total CDS feature
2270 * length is 3 times the peptide length (optionally after dropping a trailing
2271 * stop codon). This method does not check whether the CDS nucleotide sequence
2272 * translates to the peptide sequence.
2278 public static MapList mapCdsToProtein(SequenceI dnaSeq,
2279 SequenceI proteinSeq)
2281 List<int[]> ranges = findCdsPositions(dnaSeq);
2282 int mappedDnaLength = MappingUtils.getLength(ranges);
2285 * if not a whole number of codons, truncate mapping
2287 int codonRemainder = mappedDnaLength % CODON_LENGTH;
2288 if (codonRemainder > 0)
2290 mappedDnaLength -= codonRemainder;
2291 MappingUtils.removeEndPositions(codonRemainder, ranges);
2294 int proteinLength = proteinSeq.getLength();
2295 int proteinStart = proteinSeq.getStart();
2296 int proteinEnd = proteinSeq.getEnd();
2299 * incomplete start codon may mean X at start of peptide
2300 * we ignore both for mapping purposes
2302 if (proteinSeq.getCharAt(0) == 'X')
2304 // todo JAL-2022 support startPhase > 0
2308 List<int[]> proteinRange = new ArrayList<>();
2311 * dna length should map to protein (or protein plus stop codon)
2313 int codesForResidues = mappedDnaLength / CODON_LENGTH;
2314 if (codesForResidues == (proteinLength + 1))
2316 // assuming extra codon is for STOP and not in peptide
2317 // todo: check trailing codon is indeed a STOP codon
2319 mappedDnaLength -= CODON_LENGTH;
2320 MappingUtils.removeEndPositions(CODON_LENGTH, ranges);
2323 if (codesForResidues == proteinLength)
2325 proteinRange.add(new int[] { proteinStart, proteinEnd });
2326 return new MapList(ranges, proteinRange, CODON_LENGTH, 1);
2332 * Returns a list of CDS ranges found (as sequence positions base 1), i.e. of
2333 * [start, end] positions of sequence features of type "CDS" (or a sub-type of
2334 * CDS in the Sequence Ontology). The ranges are sorted into ascending start
2335 * position order, so this method is only valid for linear CDS in the same
2336 * sense as the protein product.
2341 protected static List<int[]> findCdsPositions(SequenceI dnaSeq)
2343 List<int[]> result = new ArrayList<>();
2345 List<SequenceFeature> sfs = dnaSeq.getFeatures().getFeaturesByOntology(
2346 SequenceOntologyI.CDS);
2351 SequenceFeatures.sortFeatures(sfs, true);
2353 for (SequenceFeature sf : sfs)
2358 String s = sf.getPhase();
2361 phase = Integer.parseInt(s);
2363 } catch (NumberFormatException e)
2368 * phase > 0 on first codon means 5' incomplete - skip to the start
2369 * of the next codon; example ENST00000496384
2371 int begin = sf.getBegin();
2372 int end = sf.getEnd();
2373 if (result.isEmpty() && phase > 0)
2378 // shouldn't happen!
2380 .println("Error: start phase extends beyond start CDS in "
2381 + dnaSeq.getName());
2384 result.add(new int[] { begin, end });
2388 * Finally sort ranges by start position. This avoids a dependency on
2389 * keeping features in order on the sequence (if they are in order anyway,
2390 * the sort will have almost no work to do). The implicit assumption is CDS
2391 * ranges are assembled in order. Other cases should not use this method,
2392 * but instead construct an explicit mapping for CDS (e.g. EMBL parsing).
2394 Collections.sort(result, IntRangeComparator.ASCENDING);
2399 * Makes an alignment with a copy of the given sequences, adding in any
2400 * non-redundant sequences which are mapped to by the cross-referenced
2406 * the alignment dataset shared by the new copy
2409 public static AlignmentI makeCopyAlignment(SequenceI[] seqs,
2410 SequenceI[] xrefs, AlignmentI dataset)
2412 AlignmentI copy = new Alignment(new Alignment(seqs));
2413 copy.setDataset(dataset);
2414 boolean isProtein = !copy.isNucleotide();
2415 SequenceIdMatcher matcher = new SequenceIdMatcher(seqs);
2418 // BH 2019.01.25 recoded to remove iterators
2420 for (int ix = 0, nx = xrefs.length; ix < nx; ix++)
2422 SequenceI xref = xrefs[ix];
2423 List<DBRefEntry> dbrefs = xref.getDBRefs();
2426 for (int ir = 0, nir = dbrefs.size(); ir < nir; ir++)
2428 DBRefEntry dbref = dbrefs.get(ir);
2429 Mapping map = dbref.getMap();
2431 if (map == null || (mto = map.getTo()) == null
2432 || mto.isProtein() != isProtein)
2436 SequenceI mappedTo = mto;
2437 SequenceI match = matcher.findIdMatch(mappedTo);
2440 matcher.add(mappedTo);
2441 copy.addSequence(mappedTo);
2451 * Try to align sequences in 'unaligned' to match the alignment of their
2452 * mapped regions in 'aligned'. For example, could use this to align CDS
2453 * sequences which are mapped to their parent cDNA sequences.
2455 * This method handles 1:1 mappings (dna-to-dna or protein-to-protein). For
2456 * dna-to-protein or protein-to-dna use alternative methods.
2459 * sequences to be aligned
2461 * holds aligned sequences and their mappings
2464 public static int alignAs(AlignmentI unaligned, AlignmentI aligned)
2467 * easy case - aligning a copy of aligned sequences
2469 if (alignAsSameSequences(unaligned, aligned))
2471 return unaligned.getHeight();
2475 * fancy case - aligning via mappings between sequences
2477 List<SequenceI> unmapped = new ArrayList<>();
2478 Map<Integer, Map<SequenceI, Character>> columnMap = buildMappedColumnsMap(
2479 unaligned, aligned, unmapped);
2480 int width = columnMap.size();
2481 char gap = unaligned.getGapCharacter();
2482 int realignedCount = 0;
2483 // TODO: verify this loop scales sensibly for very wide/high alignments
2485 for (SequenceI seq : unaligned.getSequences())
2487 if (!unmapped.contains(seq))
2489 char[] newSeq = new char[width];
2490 Arrays.fill(newSeq, gap); // JBPComment - doubt this is faster than the
2491 // Integer iteration below
2496 * traverse the map to find columns populated
2499 for (Integer column : columnMap.keySet())
2501 Character c = columnMap.get(column).get(seq);
2505 * sequence has a character at this position
2515 * trim trailing gaps
2517 if (lastCol < width)
2519 char[] tmp = new char[lastCol + 1];
2520 System.arraycopy(newSeq, 0, tmp, 0, lastCol + 1);
2523 // TODO: optimise SequenceI to avoid char[]->String->char[]
2524 seq.setSequence(String.valueOf(newSeq));
2528 return realignedCount;
2532 * If unaligned and aligned sequences share the same dataset sequences, then
2533 * simply copies the aligned sequences to the unaligned sequences and returns
2534 * true; else returns false
2537 * - sequences to be aligned based on aligned
2539 * - 'guide' alignment containing sequences derived from same
2540 * dataset as unaligned
2543 static boolean alignAsSameSequences(AlignmentI unaligned,
2546 if (aligned.getDataset() == null || unaligned.getDataset() == null)
2548 return false; // should only pass alignments with datasets here
2551 // map from dataset sequence to alignment sequence(s)
2552 Map<SequenceI, List<SequenceI>> alignedDatasets = new HashMap<>();
2553 for (SequenceI seq : aligned.getSequences())
2555 SequenceI ds = seq.getDatasetSequence();
2556 if (alignedDatasets.get(ds) == null)
2558 alignedDatasets.put(ds, new ArrayList<SequenceI>());
2560 alignedDatasets.get(ds).add(seq);
2564 * first pass - check whether all sequences to be aligned share a
2565 * dataset sequence with an aligned sequence; also note the leftmost
2566 * ungapped column from which to copy
2568 int leftmost = Integer.MAX_VALUE;
2569 for (SequenceI seq : unaligned.getSequences())
2571 final SequenceI ds = seq.getDatasetSequence();
2572 if (!alignedDatasets.containsKey(ds))
2576 SequenceI alignedSeq = alignedDatasets.get(ds)
2578 int startCol = alignedSeq.findIndex(seq.getStart()); // 1..
2579 leftmost = Math.min(leftmost, startCol);
2583 * second pass - copy aligned sequences;
2584 * heuristic rule: pair off sequences in order for the case where
2585 * more than one shares the same dataset sequence
2587 final char gapCharacter = aligned.getGapCharacter();
2588 for (SequenceI seq : unaligned.getSequences())
2590 List<SequenceI> alignedSequences = alignedDatasets
2591 .get(seq.getDatasetSequence());
2592 if (alignedSequences.isEmpty())
2595 * defensive check - shouldn't happen! (JAL-3536)
2599 SequenceI alignedSeq = alignedSequences.get(0);
2602 * gap fill for leading (5') UTR if any
2604 // TODO this copies intron columns - wrong!
2605 int startCol = alignedSeq.findIndex(seq.getStart()); // 1..
2606 int endCol = alignedSeq.findIndex(seq.getEnd());
2607 char[] seqchars = new char[endCol - leftmost + 1];
2608 Arrays.fill(seqchars, gapCharacter);
2609 char[] toCopy = alignedSeq.getSequence(startCol - 1, endCol);
2610 System.arraycopy(toCopy, 0, seqchars, startCol - leftmost,
2612 seq.setSequence(String.valueOf(seqchars));
2613 if (alignedSequences.size() > 0)
2615 // pop off aligned sequences (except the last one)
2616 alignedSequences.remove(0);
2621 * finally remove gapped columns (e.g. introns)
2623 new RemoveGapColCommand("", unaligned.getSequencesArray(), 0,
2624 unaligned.getWidth() - 1, unaligned);
2630 * Returns a map whose key is alignment column number (base 1), and whose
2631 * values are a map of sequence characters in that column.
2638 static SortedMap<Integer, Map<SequenceI, Character>> buildMappedColumnsMap(
2639 AlignmentI unaligned, AlignmentI aligned,
2640 List<SequenceI> unmapped)
2643 * Map will hold, for each aligned column position, a map of
2644 * {unalignedSequence, characterPerSequence} at that position.
2645 * TreeMap keeps the entries in ascending column order.
2647 SortedMap<Integer, Map<SequenceI, Character>> map = new TreeMap<>();
2650 * record any sequences that have no mapping so can't be realigned
2652 unmapped.addAll(unaligned.getSequences());
2654 List<AlignedCodonFrame> mappings = aligned.getCodonFrames();
2656 for (SequenceI seq : unaligned.getSequences())
2658 for (AlignedCodonFrame mapping : mappings)
2660 SequenceI fromSeq = mapping.findAlignedSequence(seq, aligned);
2661 if (fromSeq != null)
2663 Mapping seqMap = mapping.getMappingBetween(fromSeq, seq);
2664 if (addMappedPositions(seq, fromSeq, seqMap, map))
2666 unmapped.remove(seq);
2675 * Helper method that adds to a map the mapped column positions of a sequence.
2677 * For example if aaTT-Tg-gAAA is mapped to TTTAAA then the map should record
2678 * that columns 3,4,6,10,11,12 map to characters T,T,T,A,A,A of the mapped to
2682 * the sequence whose column positions we are recording
2684 * a sequence that is mapped to the first sequence
2686 * the mapping from 'fromSeq' to 'seq'
2688 * a map to add the column positions (in fromSeq) of the mapped
2692 static boolean addMappedPositions(SequenceI seq, SequenceI fromSeq,
2693 Mapping seqMap, Map<Integer, Map<SequenceI, Character>> map)
2701 * invert mapping if it is from unaligned to aligned sequence
2703 if (seqMap.getTo() == fromSeq.getDatasetSequence())
2705 seqMap = new Mapping(seq.getDatasetSequence(),
2706 seqMap.getMap().getInverse());
2709 int toStart = seq.getStart();
2712 * traverse [start, end, start, end...] ranges in fromSeq
2714 for (int[] fromRange : seqMap.getMap().getFromRanges())
2716 for (int i = 0; i < fromRange.length - 1; i += 2)
2718 boolean forward = fromRange[i + 1] >= fromRange[i];
2721 * find the range mapped to (sequence positions base 1)
2723 int[] range = seqMap.locateMappedRange(fromRange[i],
2727 System.err.println("Error in mapping " + seqMap + " from "
2728 + fromSeq.getName());
2731 int fromCol = fromSeq.findIndex(fromRange[i]);
2732 int mappedCharPos = range[0];
2735 * walk over the 'from' aligned sequence in forward or reverse
2736 * direction; when a non-gap is found, record the column position
2737 * of the next character of the mapped-to sequence; stop when all
2738 * the characters of the range have been counted
2740 while (mappedCharPos <= range[1] && fromCol <= fromSeq.getLength()
2743 if (!Comparison.isGap(fromSeq.getCharAt(fromCol - 1)))
2746 * mapped from sequence has a character in this column
2747 * record the column position for the mapped to character
2749 Map<SequenceI, Character> seqsMap = map.get(fromCol);
2750 if (seqsMap == null)
2752 seqsMap = new HashMap<>();
2753 map.put(fromCol, seqsMap);
2755 seqsMap.put(seq, seq.getCharAt(mappedCharPos - toStart));
2758 fromCol += (forward ? 1 : -1);
2765 // strictly temporary hack until proper criteria for aligning protein to cds
2766 // are in place; this is so Ensembl -> fetch xrefs Uniprot aligns the Uniprot
2767 public static boolean looksLikeEnsembl(AlignmentI alignment)
2769 for (SequenceI seq : alignment.getSequences())
2771 String name = seq.getName();
2772 if (!name.startsWith("ENSG") && !name.startsWith("ENST"))