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 jalview.api.AlignViewportI;
24 import jalview.datamodel.AlignedCodon;
25 import jalview.datamodel.AlignedCodonFrame;
26 import jalview.datamodel.Alignment;
27 import jalview.datamodel.AlignmentAnnotation;
28 import jalview.datamodel.AlignmentI;
29 import jalview.datamodel.Annotation;
30 import jalview.datamodel.DBRefEntry;
31 import jalview.datamodel.DBRefSource;
32 import jalview.datamodel.FeatureProperties;
33 import jalview.datamodel.GraphLine;
34 import jalview.datamodel.Mapping;
35 import jalview.datamodel.Sequence;
36 import jalview.datamodel.SequenceFeature;
37 import jalview.datamodel.SequenceI;
38 import jalview.schemes.ResidueProperties;
39 import jalview.util.Comparison;
40 import jalview.util.DBRefUtils;
41 import jalview.util.MapList;
42 import jalview.util.ShiftList;
44 import java.util.ArrayList;
45 import java.util.Arrays;
46 import java.util.Comparator;
47 import java.util.Iterator;
48 import java.util.List;
52 private static final String STOP_ASTERIX = "*";
54 private static final Comparator<AlignedCodon> comparator = new CodonComparator();
57 * 'final' variables describe the inputs to the translation, which should not
60 private final List<SequenceI> selection;
62 private final String[] seqstring;
64 private final Iterator<int[]> contigs;
66 private final char gapChar;
68 private final AlignmentAnnotation[] annotations;
70 private final int dnaWidth;
72 private final AlignmentI dataset;
74 private ShiftList vismapping;
76 private int[] startcontigs;
79 * Working variables for the translation.
81 * The width of the translation-in-progress protein alignment.
83 private int aaWidth = 0;
86 * This array will be built up so that position i holds the codon positions
87 * e.g. [7, 9, 10] that match column i (base 0) in the aligned translation.
88 * Note this implies a contract that if two codons do not align exactly, their
89 * translated products must occupy different column positions.
91 private AlignedCodon[] alignedCodons;
94 * Constructor given a viewport and the visible contigs.
97 * @param visibleContigs
99 public Dna(AlignViewportI viewport, Iterator<int[]> visibleContigs)
101 this.selection = Arrays.asList(viewport.getSequenceSelection());
102 this.seqstring = viewport.getViewAsString(true);
103 this.contigs = visibleContigs;
104 this.gapChar = viewport.getGapCharacter();
105 this.annotations = viewport.getAlignment().getAlignmentAnnotation();
106 this.dnaWidth = viewport.getAlignment().getWidth();
107 this.dataset = viewport.getAlignment().getDataset();
112 * Initialise contigs used as starting point for translateCodingRegion
114 private void initContigs()
116 vismapping = new ShiftList(); // map from viscontigs to seqstring
120 int[] lastregion = null;
121 ArrayList<Integer> tempcontigs = new ArrayList<>();
122 while (contigs.hasNext())
124 int[] region = contigs.next();
125 if (lastregion == null)
127 vismapping.addShift(npos, region[0]);
132 vismapping.addShift(npos, region[0] - lastregion[1] + 1);
135 tempcontigs.add(region[0]);
136 tempcontigs.add(region[1]);
139 startcontigs = new int[tempcontigs.size()];
141 for (Integer val : tempcontigs)
143 startcontigs[i] = val;
150 * Test whether codon positions cdp1 should align before, with, or after cdp2.
151 * Returns zero if all positions match (or either argument is null). Returns
152 * -1 if any position in the first codon precedes the corresponding position
153 * in the second codon. Else returns +1 (some position in the second codon
154 * precedes the corresponding position in the first).
156 * Note this is not necessarily symmetric, for example:
158 * <li>compareCodonPos([2,5,6], [3,4,5]) returns -1</li>
159 * <li>compareCodonPos([3,4,5], [2,5,6]) also returns -1</li>
166 public static final int compareCodonPos(AlignedCodon ac1,
169 return comparator.compare(ac1, ac2);
170 // return jalview_2_8_2compare(ac1, ac2);
174 * Codon comparison up to Jalview 2.8.2. This rule is sequence order dependent
175 * - see http://issues.jalview.org/browse/JAL-1635
181 private static int jalview_2_8_2compare(AlignedCodon ac1,
184 if (ac1 == null || ac2 == null || (ac1.equals(ac2)))
188 if (ac1.pos1 < ac2.pos1 || ac1.pos2 < ac2.pos2 || ac1.pos3 < ac2.pos3)
190 // one base in cdp1 precedes the corresponding base in the other codon
193 // one base in cdp1 appears after the corresponding base in the other codon.
198 * Translates cDNA using the specified code table
202 public AlignmentI translateCdna(GeneticCodeI codeTable)
204 AlignedCodonFrame acf = new AlignedCodonFrame();
206 alignedCodons = new AlignedCodon[dnaWidth];
209 int sSize = selection.size();
210 List<SequenceI> pepseqs = new ArrayList<>();
211 for (s = 0; s < sSize; s++)
213 SequenceI newseq = translateCodingRegion(selection.get(s),
214 seqstring[s], acf, pepseqs, codeTable);
219 SequenceI ds = newseq;
222 while (ds.getDatasetSequence() != null)
224 ds = ds.getDatasetSequence();
226 dataset.addSequence(ds);
231 SequenceI[] newseqs = pepseqs.toArray(new SequenceI[pepseqs.size()]);
232 AlignmentI al = new Alignment(newseqs);
233 // ensure we look aligned.
235 // link the protein translation to the DNA dataset
236 al.setDataset(dataset);
237 translateAlignedAnnotations(al, acf);
238 al.addCodonFrame(acf);
243 * fake the collection of DbRefs with associated exon mappings to identify if
244 * a translation would generate distinct product in the currently selected
251 public static boolean canTranslate(SequenceI[] selection,
254 for (int gd = 0; gd < selection.length; gd++)
256 SequenceI dna = selection[gd];
257 List<DBRefEntry> dnarefs = DBRefUtils.selectRefs(dna.getDBRefs(),
258 jalview.datamodel.DBRefSource.DNACODINGDBS);
261 // intersect with pep
262 List<DBRefEntry> mappedrefs = new ArrayList<>();
263 List<DBRefEntry> refs = dna.getDBRefs();
264 for (int d = 0, nd = refs.size(); d < nd; d++)
266 DBRefEntry ref = refs.get(d);
267 if (ref.getMap() != null && ref.getMap().getMap() != null
268 && ref.getMap().getMap().getFromRatio() == 3
269 && ref.getMap().getMap().getToRatio() == 1)
271 mappedrefs.add(ref); // add translated protein maps
274 dnarefs = mappedrefs;// .toArray(new DBRefEntry[mappedrefs.size()]);
275 for (int d = 0, nd = dnarefs.size(); d < nd; d++)
277 Mapping mp = dnarefs.get(d).getMap();
280 for (int vc = 0, nv = viscontigs.length; vc < nv; vc += 2)
282 int[] mpr = mp.locateMappedRange(viscontigs[vc],
297 * Translate nucleotide alignment annotations onto translated amino acid
298 * alignment using codon mapping codons
301 * the translated protein alignment
303 protected void translateAlignedAnnotations(AlignmentI al,
304 AlignedCodonFrame acf)
306 // Can only do this for columns with consecutive codons, or where
307 // annotation is sequence associated.
309 if (annotations != null)
311 for (AlignmentAnnotation annotation : annotations)
314 * Skip hidden or autogenerated annotation. Also (for now), RNA
315 * secondary structure annotation. If we want to show this against
316 * protein we need a smarter way to 'translate' without generating
317 * invalid (unbalanced) structure annotation.
319 if (annotation.autoCalculated || !annotation.visible
320 || annotation.isRNA())
326 Annotation[] anots = (annotation.annotations == null) ? null
327 : new Annotation[aSize];
330 for (int a = 0; a < aSize; a++)
332 // process through codon map.
333 if (a < alignedCodons.length && alignedCodons[a] != null
334 && alignedCodons[a].pos1 == (alignedCodons[a].pos3 - 2))
336 anots[a] = getCodonAnnotation(alignedCodons[a],
337 annotation.annotations);
342 AlignmentAnnotation aa = new AlignmentAnnotation(annotation.label,
343 annotation.description, anots);
344 aa.graph = annotation.graph;
345 aa.graphGroup = annotation.graphGroup;
346 aa.graphHeight = annotation.graphHeight;
347 if (annotation.getThreshold() != null)
349 aa.setThreshold(new GraphLine(annotation.getThreshold()));
351 if (annotation.hasScore)
353 aa.setScore(annotation.getScore());
356 final SequenceI seqRef = annotation.sequenceRef;
359 SequenceI aaSeq = acf.getAaForDnaSeq(seqRef);
362 // aa.compactAnnotationArray(); // throw away alignment annotation
364 aa.setSequenceRef(aaSeq);
366 aa.createSequenceMapping(aaSeq, aaSeq.getStart(), true);
367 aa.adjustForAlignment();
368 aaSeq.addAlignmentAnnotation(aa);
371 al.addAnnotation(aa);
376 private static Annotation getCodonAnnotation(AlignedCodon is,
377 Annotation[] annotations)
379 // Have a look at all the codon positions for annotation and put the first
380 // one found into the translated annotation pos.
382 Annotation annot = null;
383 for (int p = 1; p <= 3; p++)
385 int dnaCol = is.getBaseColumn(p);
386 if (annotations[dnaCol] != null)
390 annot = new Annotation(annotations[dnaCol]);
396 Annotation cpy = new Annotation(annotations[dnaCol]);
397 if (annot.colour == null)
399 annot.colour = cpy.colour;
401 if (annot.description == null || annot.description.length() == 0)
403 annot.description = cpy.description;
405 if (annot.displayCharacter == null)
407 annot.displayCharacter = cpy.displayCharacter;
409 if (annot.secondaryStructure == 0)
411 annot.secondaryStructure = cpy.secondaryStructure;
413 annot.value += cpy.value;
420 annot.value /= contrib;
426 * Translate a na sequence
429 * sequence displayed under viscontigs visible columns
431 * ORF read in some global alignment reference frame
433 * Definition of global ORF alignment reference frame
436 * @return sequence ready to be added to alignment.
438 protected SequenceI translateCodingRegion(SequenceI selection,
439 String seqstring, AlignedCodonFrame acf,
440 List<SequenceI> proteinSeqs, GeneticCodeI codeTable)
442 List<int[]> skip = new ArrayList<>();
443 int[] skipint = null;
448 int[] scontigs = new int[startcontigs.length];
449 System.arraycopy(startcontigs, 0, scontigs, 0, startcontigs.length);
451 // allocate a roughly sized buffer for the protein sequence
452 StringBuilder protein = new StringBuilder(seqstring.length() / 2);
453 String seq = seqstring.replace('U', 'T').replace('u', 'T');
454 char codon[] = new char[3];
455 int cdp[] = new int[3];
461 for (npos = 0, nend = seq.length(); npos < nend; npos++)
463 if (!Comparison.isGap(seq.charAt(npos)))
465 cdp[rf] = npos; // store position
466 codon[rf++] = seq.charAt(npos); // store base
471 * Filled up a reading frame...
473 AlignedCodon alignedCodon = new AlignedCodon(cdp[0], cdp[1],
475 String aa = codeTable.translate(new String(codon));
477 final String gapString = String.valueOf(gapChar);
483 skipint = new int[] { alignedCodon.pos1,
489 skipint[1] = alignedCodon.pos3; // cdp[2];
496 skipint[0] = vismapping.shift(skipint[0]);
497 skipint[1] = vismapping.shift(skipint[1]);
498 for (vc = 0; vc < scontigs.length;)
500 if (scontigs[vc + 1] < skipint[0])
502 // before skipint starts
506 if (scontigs[vc] > skipint[1])
508 // finished editing so
511 // Edit the contig list to include the skipped region which did
514 // from : s1 e1 s2 e2 s3 e3
515 // to s: s1 e1 s2 k0 k1 e2 s3 e3
516 // list increases by one unless one boundary (s2==k0 or e2==k1)
517 // matches, and decreases by one if skipint intersects whole
519 if (scontigs[vc] <= skipint[0])
521 if (skipint[0] == scontigs[vc])
523 // skipint at start of contig
524 // shift the start of this contig
525 if (scontigs[vc + 1] > skipint[1])
527 scontigs[vc] = skipint[1];
532 if (scontigs[vc + 1] == skipint[1])
535 t = new int[scontigs.length - 2];
538 System.arraycopy(scontigs, 0, t, 0, vc - 1);
540 if (vc + 2 < t.length)
542 System.arraycopy(scontigs, vc + 2, t, vc,
549 // truncate contig to before the skipint region
550 scontigs[vc + 1] = skipint[0] - 1;
557 // scontig starts before start of skipint
558 if (scontigs[vc + 1] < skipint[1])
560 // skipint truncates end of scontig
561 scontigs[vc + 1] = skipint[0] - 1;
566 // divide region to new contigs
567 t = new int[scontigs.length + 2];
568 System.arraycopy(scontigs, 0, t, 0, vc + 1);
569 t[vc + 1] = skipint[0];
570 t[vc + 2] = skipint[1];
571 System.arraycopy(scontigs, vc + 1, t, vc + 3,
572 scontigs.length - (vc + 1));
582 if (aa.equals(ResidueProperties.STOP))
588 boolean findpos = true;
592 * Compare this codon's base positions with those currently aligned to
593 * this column in the translation.
595 final int compareCodonPos = compareCodonPos(alignedCodon,
596 alignedCodons[aspos]);
597 switch (compareCodonPos)
602 * This codon should precede the mapped positions - need to insert a
603 * gap in all prior sequences.
605 insertAAGap(aspos, proteinSeqs);
612 * This codon belongs after the aligned codons at aspos. Prefix it
613 * with a gap and try the next position.
622 * Exact match - codon 'belongs' at this translated position.
629 if (alignedCodons[aspos] == null)
631 // mark this column as aligning to this aligned reading frame
632 alignedCodons[aspos] = alignedCodon;
634 else if (!alignedCodons[aspos].equals(alignedCodon))
636 throw new IllegalStateException(
637 "Tried to coalign " + alignedCodons[aspos].toString()
638 + " with " + alignedCodon.toString());
640 if (aspos >= aaWidth)
642 // update maximum alignment width
645 // ready for next translated reading frame alignment position (if any)
651 SequenceI newseq = new Sequence(selection.getName(),
655 final String errMsg = "trimming contigs for incomplete terminal codon.";
656 jalview.bin.Console.errPrintln(errMsg);
657 // map and trim contigs to ORF region
658 vc = scontigs.length - 1;
659 lastnpos = vismapping.shift(lastnpos); // place npos in context of
660 // whole dna alignment (rather
661 // than visible contigs)
662 // incomplete ORF could be broken over one or two visible contig
664 while (vc >= 0 && scontigs[vc] > lastnpos)
666 if (vc > 0 && scontigs[vc - 1] > lastnpos)
672 // correct last interval in list.
673 scontigs[vc] = lastnpos;
677 if (vc > 0 && (vc + 1) < scontigs.length)
679 // truncate map list to just vc elements
680 int t[] = new int[vc + 1];
681 System.arraycopy(scontigs, 0, t, 0, vc + 1);
689 if (scontigs != null)
692 // map scontigs to actual sequence positions on selection
693 for (vc = 0; vc < scontigs.length; vc += 2)
695 scontigs[vc] = selection.findPosition(scontigs[vc]); // not from 1!
696 scontigs[vc + 1] = selection.findPosition(scontigs[vc + 1]); // exclusive
697 if (scontigs[vc + 1] == selection.getEnd())
702 // trim trailing empty intervals.
703 if ((vc + 2) < scontigs.length)
705 int t[] = new int[vc + 2];
706 System.arraycopy(scontigs, 0, t, 0, vc + 2);
710 * delete intervals in scontigs which are not translated. 1. map skip
711 * into sequence position intervals 2. truncate existing ranges and add
712 * new ranges to exclude untranslated regions. if (skip.size()>0) {
713 * Vector narange = new Vector(); for (vc=0; vc<scontigs.length; vc++) {
714 * narange.addElement(new int[] {scontigs[vc]}); } int sint=0,iv[]; vc =
715 * 0; while (sint<skip.size()) { skipint = (int[]) skip.elementAt(sint);
716 * do { iv = (int[]) narange.elementAt(vc); if (iv[0]>=skipint[0] &&
717 * iv[0]<=skipint[1]) { if (iv[0]==skipint[0]) { // delete beginning of
718 * range } else { // truncate range and create new one if necessary iv =
719 * (int[]) narange.elementAt(vc+1); if (iv[0]<=skipint[1]) { // truncate
720 * range iv[0] = skipint[1]; } else { } } } else if (iv[0]<skipint[0]) {
721 * iv = (int[]) narange.elementAt(vc+1); } } while (iv[0]) } }
723 MapList map = new MapList(scontigs, new int[] { 1, resSize }, 3, 1);
725 transferCodedFeatures(selection, newseq, map);
728 * Construct a dataset sequence for our new peptide.
730 SequenceI rseq = newseq.deriveSequence();
733 * Store a mapping (between the dataset sequences for the two
736 // SIDE-EFFECT: acf stores the aligned sequence reseq; to remove!
737 acf.addMap(selection, rseq, map);
741 // register the mapping somehow
747 * Insert a gap into the aligned proteins and the codon mapping array.
753 protected void insertAAGap(int pos, List<SequenceI> proteinSeqs)
756 for (SequenceI seq : proteinSeqs)
758 seq.insertCharAt(pos, gapChar);
761 checkCodonFrameWidth();
767 * Shift from [pos] to the end one to the right, and null out [pos]
769 System.arraycopy(alignedCodons, pos, alignedCodons, pos + 1,
770 alignedCodons.length - pos - 1);
771 alignedCodons[pos] = null;
776 * Check the codons array can accommodate a single insertion, if not resize
779 protected void checkCodonFrameWidth()
781 if (alignedCodons[alignedCodons.length - 1] != null)
784 * arraycopy insertion would bump a filled slot off the end, so expand.
786 AlignedCodon[] c = new AlignedCodon[alignedCodons.length + 10];
787 System.arraycopy(alignedCodons, 0, c, 0, alignedCodons.length);
793 * Given a peptide newly translated from a dna sequence, copy over and set any
794 * features on the peptide from the DNA.
800 private static void transferCodedFeatures(SequenceI dna, SequenceI pep,
803 // BH 2019.01.25 nop?
804 // List<DBRefEntry> dnarefs = DBRefUtils.selectRefs(dna.getDBRefs(),
805 // DBRefSource.DNACODINGDBS);
806 // if (dnarefs != null)
808 // // intersect with pep
809 // for (int d = 0, nd = dnarefs.size(); d < nd; d++)
811 // Mapping mp = dnarefs.get(d).getMap();
817 for (SequenceFeature sf : dna.getFeatures().getAllFeatures())
819 if (FeatureProperties.isCodingFeature(null, sf.getType()))
821 // if (map.intersectsFrom(sf[f].begin, sf[f].end))
830 * Returns an alignment consisting of the reversed (and optionally
831 * complemented) sequences set in this object's constructor
836 public AlignmentI reverseCdna(boolean complement)
838 int sSize = selection.size();
839 List<SequenceI> reversed = new ArrayList<>();
840 for (int s = 0; s < sSize; s++)
842 SequenceI newseq = reverseSequence(selection.get(s).getName(),
843 seqstring[s], complement);
847 reversed.add(newseq);
851 SequenceI[] newseqs = reversed.toArray(new SequenceI[reversed.size()]);
852 AlignmentI al = new Alignment(newseqs);
853 ((Alignment) al).createDatasetAlignment();
858 * Returns a reversed, and optionally complemented, sequence. The new
859 * sequence's name is the original name with "|rev" or "|revcomp" appended.
860 * aAcCgGtT and DNA ambiguity codes are complemented, any other characters are
867 public static SequenceI reverseSequence(String seqName, String sequence,
870 String newName = seqName + "|rev" + (complement ? "comp" : "");
871 char[] originalSequence = sequence.toCharArray();
872 int length = originalSequence.length;
873 char[] reversedSequence = new char[length];
875 for (int i = 0; i < length; i++)
877 char c = complement ? getComplement(originalSequence[i])
878 : originalSequence[i];
879 reversedSequence[length - i - 1] = c;
880 if (!Comparison.isGap(c))
885 SequenceI reversed = new Sequence(newName, reversedSequence, 1, bases);
890 * Answers the reverse complement of the input string
892 * @see #getComplement(char)
896 public static String reverseComplement(String s)
898 StringBuilder sb = new StringBuilder(s.length());
899 for (int i = s.length() - 1; i >= 0; i--)
901 sb.append(Dna.getComplement(s.charAt(i)));
903 return sb.toString();
907 * Returns dna complement (preserving case) for aAcCgGtTuU. Ambiguity codes
908 * are treated as on http://reverse-complement.com/. Anything else is left
914 public static char getComplement(char c)