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, AlignedCodon ac2)
168 return comparator.compare(ac1, ac2);
169 // return jalview_2_8_2compare(ac1, ac2);
173 * Codon comparison up to Jalview 2.8.2. This rule is sequence order dependent
174 * - see http://issues.jalview.org/browse/JAL-1635
180 private static int jalview_2_8_2compare(AlignedCodon ac1,
183 if (ac1 == null || ac2 == null || (ac1.equals(ac2)))
187 if (ac1.pos1 < ac2.pos1 || ac1.pos2 < ac2.pos2 || ac1.pos3 < ac2.pos3)
189 // one base in cdp1 precedes the corresponding base in the other codon
192 // one base in cdp1 appears after the corresponding base in the other codon.
197 * Translates cDNA using the specified code table
201 public AlignmentI translateCdna(GeneticCodeI codeTable)
203 AlignedCodonFrame acf = new AlignedCodonFrame();
205 alignedCodons = new AlignedCodon[dnaWidth];
208 int sSize = selection.size();
209 List<SequenceI> pepseqs = new ArrayList<>();
210 for (s = 0; s < sSize; s++)
212 SequenceI newseq = translateCodingRegion(selection.get(s),
213 seqstring[s], acf, pepseqs, codeTable);
218 SequenceI ds = newseq;
221 while (ds.getDatasetSequence() != null)
223 ds = ds.getDatasetSequence();
225 dataset.addSequence(ds);
230 SequenceI[] newseqs = pepseqs.toArray(new SequenceI[pepseqs.size()]);
231 AlignmentI al = new Alignment(newseqs);
232 // ensure we look aligned.
234 // link the protein translation to the DNA dataset
235 al.setDataset(dataset);
236 translateAlignedAnnotations(al, acf);
237 al.addCodonFrame(acf);
242 * fake the collection of DbRefs with associated exon mappings to identify if
243 * a translation would generate distinct product in the currently selected
250 public static boolean canTranslate(SequenceI[] selection,
253 for (int gd = 0; gd < selection.length; gd++)
255 SequenceI dna = selection[gd];
256 List<DBRefEntry> dnarefs = DBRefUtils.selectRefs(dna.getDBRefs(),
257 jalview.datamodel.DBRefSource.DNACODINGDBS);
260 // intersect with pep
261 List<DBRefEntry> mappedrefs = new ArrayList<>();
262 List<DBRefEntry> refs = dna.getDBRefs();
263 for (int d = 0, nd = refs.size(); d < nd; d++)
265 DBRefEntry ref = refs.get(d);
266 if (ref.getMap() != null && ref.getMap().getMap() != null
267 && ref.getMap().getMap().getFromRatio() == 3
268 && ref.getMap().getMap().getToRatio() == 1)
270 mappedrefs.add(ref); // add translated protein maps
273 dnarefs = mappedrefs;//.toArray(new DBRefEntry[mappedrefs.size()]);
274 for (int d = 0, nd = dnarefs.size(); d < nd; d++)
276 Mapping mp = dnarefs.get(d).getMap();
279 for (int vc = 0, nv = viscontigs.length; vc < nv; vc += 2)
281 int[] mpr = mp.locateMappedRange(viscontigs[vc],
296 * Translate nucleotide alignment annotations onto translated amino acid
297 * alignment using codon mapping codons
300 * the translated protein alignment
302 protected void translateAlignedAnnotations(AlignmentI al,
303 AlignedCodonFrame acf)
305 // Can only do this for columns with consecutive codons, or where
306 // annotation is sequence associated.
308 if (annotations != null)
310 for (AlignmentAnnotation annotation : annotations)
313 * Skip hidden or autogenerated annotation. Also (for now), RNA
314 * secondary structure annotation. If we want to show this against
315 * protein we need a smarter way to 'translate' without generating
316 * invalid (unbalanced) structure annotation.
318 if (annotation.autoCalculated || !annotation.visible
319 || annotation.isRNA())
325 Annotation[] anots = (annotation.annotations == null) ? null
326 : new Annotation[aSize];
329 for (int a = 0; a < aSize; a++)
331 // process through codon map.
332 if (a < alignedCodons.length && alignedCodons[a] != null
333 && alignedCodons[a].pos1 == (alignedCodons[a].pos3 - 2))
335 anots[a] = getCodonAnnotation(alignedCodons[a],
336 annotation.annotations);
341 AlignmentAnnotation aa = new AlignmentAnnotation(annotation.label,
342 annotation.description, anots);
343 aa.graph = annotation.graph;
344 aa.graphGroup = annotation.graphGroup;
345 aa.graphHeight = annotation.graphHeight;
346 if (annotation.getThreshold() != null)
348 aa.setThreshold(new GraphLine(annotation.getThreshold()));
350 if (annotation.hasScore)
352 aa.setScore(annotation.getScore());
355 final SequenceI seqRef = annotation.sequenceRef;
358 SequenceI aaSeq = acf.getAaForDnaSeq(seqRef);
361 // aa.compactAnnotationArray(); // throw away alignment annotation
363 aa.setSequenceRef(aaSeq);
365 aa.createSequenceMapping(aaSeq, aaSeq.getStart(), true);
366 aa.adjustForAlignment();
367 aaSeq.addAlignmentAnnotation(aa);
370 al.addAnnotation(aa);
375 private static Annotation getCodonAnnotation(AlignedCodon is,
376 Annotation[] annotations)
378 // Have a look at all the codon positions for annotation and put the first
379 // one found into the translated annotation pos.
381 Annotation annot = null;
382 for (int p = 1; p <= 3; p++)
384 int dnaCol = is.getBaseColumn(p);
385 if (annotations[dnaCol] != null)
389 annot = new Annotation(annotations[dnaCol]);
395 Annotation cpy = new Annotation(annotations[dnaCol]);
396 if (annot.colour == null)
398 annot.colour = cpy.colour;
400 if (annot.description == null || annot.description.length() == 0)
402 annot.description = cpy.description;
404 if (annot.displayCharacter == null)
406 annot.displayCharacter = cpy.displayCharacter;
408 if (annot.secondaryStructure == 0)
410 annot.secondaryStructure = cpy.secondaryStructure;
412 annot.value += cpy.value;
419 annot.value /= contrib;
425 * Translate a na sequence
428 * sequence displayed under viscontigs visible columns
430 * ORF read in some global alignment reference frame
432 * Definition of global ORF alignment reference frame
435 * @return sequence ready to be added to alignment.
437 protected SequenceI translateCodingRegion(SequenceI selection,
438 String seqstring, AlignedCodonFrame acf,
439 List<SequenceI> proteinSeqs, GeneticCodeI codeTable)
441 List<int[]> skip = new ArrayList<>();
442 int[] skipint = null;
447 int[] scontigs = new int[startcontigs.length];
448 System.arraycopy(startcontigs, 0, scontigs, 0, startcontigs.length);
450 // allocate a roughly sized buffer for the protein sequence
451 StringBuilder protein = new StringBuilder(seqstring.length() / 2);
452 String seq = seqstring.replace('U', 'T').replace('u', 'T');
453 char codon[] = new char[3];
454 int cdp[] = new int[3];
460 for (npos = 0, nend = seq.length(); npos < nend; npos++)
462 if (!Comparison.isGap(seq.charAt(npos)))
464 cdp[rf] = npos; // store position
465 codon[rf++] = seq.charAt(npos); // store base
470 * Filled up a reading frame...
472 AlignedCodon alignedCodon = new AlignedCodon(cdp[0], cdp[1], cdp[2]);
473 String aa = codeTable.translate(new String(codon));
475 final String gapString = String.valueOf(gapChar);
481 skipint = new int[] { alignedCodon.pos1,
487 skipint[1] = alignedCodon.pos3; // cdp[2];
494 skipint[0] = vismapping.shift(skipint[0]);
495 skipint[1] = vismapping.shift(skipint[1]);
496 for (vc = 0; vc < scontigs.length;)
498 if (scontigs[vc + 1] < skipint[0])
500 // before skipint starts
504 if (scontigs[vc] > skipint[1])
506 // finished editing so
509 // Edit the contig list to include the skipped region which did
512 // from : s1 e1 s2 e2 s3 e3
513 // to s: s1 e1 s2 k0 k1 e2 s3 e3
514 // list increases by one unless one boundary (s2==k0 or e2==k1)
515 // matches, and decreases by one if skipint intersects whole
517 if (scontigs[vc] <= skipint[0])
519 if (skipint[0] == scontigs[vc])
521 // skipint at start of contig
522 // shift the start of this contig
523 if (scontigs[vc + 1] > skipint[1])
525 scontigs[vc] = skipint[1];
530 if (scontigs[vc + 1] == skipint[1])
533 t = new int[scontigs.length - 2];
536 System.arraycopy(scontigs, 0, t, 0, vc - 1);
538 if (vc + 2 < t.length)
540 System.arraycopy(scontigs, vc + 2, t, vc,
547 // truncate contig to before the skipint region
548 scontigs[vc + 1] = skipint[0] - 1;
555 // scontig starts before start of skipint
556 if (scontigs[vc + 1] < skipint[1])
558 // skipint truncates end of scontig
559 scontigs[vc + 1] = skipint[0] - 1;
564 // divide region to new contigs
565 t = new int[scontigs.length + 2];
566 System.arraycopy(scontigs, 0, t, 0, vc + 1);
567 t[vc + 1] = skipint[0];
568 t[vc + 2] = skipint[1];
569 System.arraycopy(scontigs, vc + 1, t, vc + 3,
570 scontigs.length - (vc + 1));
580 if (aa.equals(ResidueProperties.STOP))
586 boolean findpos = true;
590 * Compare this codon's base positions with those currently aligned to
591 * this column in the translation.
593 final int compareCodonPos = compareCodonPos(alignedCodon,
594 alignedCodons[aspos]);
595 switch (compareCodonPos)
600 * This codon should precede the mapped positions - need to insert a
601 * gap in all prior sequences.
603 insertAAGap(aspos, proteinSeqs);
610 * This codon belongs after the aligned codons at aspos. Prefix it
611 * with a gap and try the next position.
620 * Exact match - codon 'belongs' at this translated position.
627 if (alignedCodons[aspos] == null)
629 // mark this column as aligning to this aligned reading frame
630 alignedCodons[aspos] = alignedCodon;
632 else if (!alignedCodons[aspos].equals(alignedCodon))
634 throw new IllegalStateException(
635 "Tried to coalign " + alignedCodons[aspos].toString()
636 + " with " + alignedCodon.toString());
638 if (aspos >= aaWidth)
640 // update maximum alignment width
643 // ready for next translated reading frame alignment position (if any)
649 SequenceI newseq = new Sequence(selection.getName(),
653 final String errMsg = "trimming contigs for incomplete terminal codon.";
654 System.err.println(errMsg);
655 // map and trim contigs to ORF region
656 vc = scontigs.length - 1;
657 lastnpos = vismapping.shift(lastnpos); // place npos in context of
658 // whole dna alignment (rather
659 // than visible contigs)
660 // incomplete ORF could be broken over one or two visible contig
662 while (vc >= 0 && scontigs[vc] > lastnpos)
664 if (vc > 0 && scontigs[vc - 1] > lastnpos)
670 // correct last interval in list.
671 scontigs[vc] = lastnpos;
675 if (vc > 0 && (vc + 1) < scontigs.length)
677 // truncate map list to just vc elements
678 int t[] = new int[vc + 1];
679 System.arraycopy(scontigs, 0, t, 0, vc + 1);
687 if (scontigs != null)
690 // map scontigs to actual sequence positions on selection
691 for (vc = 0; vc < scontigs.length; vc += 2)
693 scontigs[vc] = selection.findPosition(scontigs[vc]); // not from 1!
694 scontigs[vc + 1] = selection.findPosition(scontigs[vc + 1]); // exclusive
695 if (scontigs[vc + 1] == selection.getEnd())
700 // trim trailing empty intervals.
701 if ((vc + 2) < scontigs.length)
703 int t[] = new int[vc + 2];
704 System.arraycopy(scontigs, 0, t, 0, vc + 2);
708 * delete intervals in scontigs which are not translated. 1. map skip
709 * into sequence position intervals 2. truncate existing ranges and add
710 * new ranges to exclude untranslated regions. if (skip.size()>0) {
711 * Vector narange = new Vector(); for (vc=0; vc<scontigs.length; vc++) {
712 * narange.addElement(new int[] {scontigs[vc]}); } int sint=0,iv[]; vc =
713 * 0; while (sint<skip.size()) { skipint = (int[]) skip.elementAt(sint);
714 * do { iv = (int[]) narange.elementAt(vc); if (iv[0]>=skipint[0] &&
715 * iv[0]<=skipint[1]) { if (iv[0]==skipint[0]) { // delete beginning of
716 * range } else { // truncate range and create new one if necessary iv =
717 * (int[]) narange.elementAt(vc+1); if (iv[0]<=skipint[1]) { // truncate
718 * range iv[0] = skipint[1]; } else { } } } else if (iv[0]<skipint[0]) {
719 * iv = (int[]) narange.elementAt(vc+1); } } while (iv[0]) } }
721 MapList map = new MapList(scontigs, new int[] { 1, resSize }, 3, 1);
723 transferCodedFeatures(selection, newseq, map);
726 * Construct a dataset sequence for our new peptide.
728 SequenceI rseq = newseq.deriveSequence();
731 * Store a mapping (between the dataset sequences for the two
734 // SIDE-EFFECT: acf stores the aligned sequence reseq; to remove!
735 acf.addMap(selection, rseq, map);
739 // register the mapping somehow
745 * Insert a gap into the aligned proteins and the codon mapping array.
751 protected void insertAAGap(int pos, List<SequenceI> proteinSeqs)
754 for (SequenceI seq : proteinSeqs)
756 seq.insertCharAt(pos, gapChar);
759 checkCodonFrameWidth();
765 * Shift from [pos] to the end one to the right, and null out [pos]
767 System.arraycopy(alignedCodons, pos, alignedCodons, pos + 1,
768 alignedCodons.length - pos - 1);
769 alignedCodons[pos] = null;
774 * Check the codons array can accommodate a single insertion, if not resize
777 protected void checkCodonFrameWidth()
779 if (alignedCodons[alignedCodons.length - 1] != null)
782 * arraycopy insertion would bump a filled slot off the end, so expand.
784 AlignedCodon[] c = new AlignedCodon[alignedCodons.length + 10];
785 System.arraycopy(alignedCodons, 0, c, 0, alignedCodons.length);
791 * Given a peptide newly translated from a dna sequence, copy over and set any
792 * features on the peptide from the DNA.
798 private static void transferCodedFeatures(SequenceI dna, SequenceI pep,
801 // BH 2019.01.25 nop?
802 // List<DBRefEntry> dnarefs = DBRefUtils.selectRefs(dna.getDBRefs(),
803 // DBRefSource.DNACODINGDBS);
804 // if (dnarefs != null)
806 // // intersect with pep
807 // for (int d = 0, nd = dnarefs.size(); d < nd; d++)
809 // Mapping mp = dnarefs.get(d).getMap();
815 for (SequenceFeature sf : dna.getFeatures().getAllFeatures())
817 if (FeatureProperties.isCodingFeature(null, sf.getType()))
819 // if (map.intersectsFrom(sf[f].begin, sf[f].end))
828 * Returns an alignment consisting of the reversed (and optionally
829 * complemented) sequences set in this object's constructor
834 public AlignmentI reverseCdna(boolean complement)
836 int sSize = selection.size();
837 List<SequenceI> reversed = new ArrayList<>();
838 for (int s = 0; s < sSize; s++)
840 SequenceI newseq = reverseSequence(selection.get(s).getName(),
841 seqstring[s], complement);
845 reversed.add(newseq);
849 SequenceI[] newseqs = reversed.toArray(new SequenceI[reversed.size()]);
850 AlignmentI al = new Alignment(newseqs);
851 ((Alignment) al).createDatasetAlignment();
856 * Returns a reversed, and optionally complemented, sequence. The new
857 * sequence's name is the original name with "|rev" or "|revcomp" appended.
858 * aAcCgGtT and DNA ambiguity codes are complemented, any other characters are
865 public static SequenceI reverseSequence(String seqName, String sequence,
868 String newName = seqName + "|rev" + (complement ? "comp" : "");
869 char[] originalSequence = sequence.toCharArray();
870 int length = originalSequence.length;
871 char[] reversedSequence = new char[length];
873 for (int i = 0; i < length; i++)
875 char c = complement ? getComplement(originalSequence[i])
876 : originalSequence[i];
877 reversedSequence[length - i - 1] = c;
878 if (!Comparison.isGap(c))
883 SequenceI reversed = new Sequence(newName, reversedSequence, 1, bases);
888 * Answers the reverse complement of the input string
890 * @see #getComplement(char)
894 public static String reverseComplement(String s)
896 StringBuilder sb = new StringBuilder(s.length());
897 for (int i = s.length() - 1; i >= 0; i--)
899 sb.append(Dna.getComplement(s.charAt(i)));
901 return sb.toString();
905 * Returns dna complement (preserving case) for aAcCgGtTuU. Ambiguity codes
906 * are treated as on http://reverse-complement.com/. Anything else is left
912 public static char getComplement(char c)