/gb2seq

Use a GenBank file to extract sequences for features and other information from another genome

Primary LanguagePython

A Python library and command-line scripts for working with GenBank genome sequences and annotations

gb2seq provides a Python library and command-line scripts that derive information regarding unannotated an viral genome from annotations in a GenBank reference. A typical use case is to investigate the properties of an unannotated genome called from a SAM/BAM file following alignment of high-throughput sequencing reads (e.g., with bwa or bowtie2) to a reference.

Python library

The Python library (API described below) provides for:

  • Extraction of aligned features as nucleotide or amino acid sequences.
  • Retrieving information about what is at a site (annotated features, nucleotide, amino acid, codon, frame, etc).
  • Translation of offsets between the reference and the unannotated genome with offsets that are absolute or relative to a feature.
  • Detailed alignment information for features.
  • JSON annotations of the features of the unannotated genome.
  • Convenience methods for checking genomes for sets of expected nucleotide or amino acid values.

Scripts

The command-line scripts (described below) provide a convenient interface to the library functions. There are the following scripts:

  • annotate-genome.py - prints a JSON object containing details of all features of an unannotated genome (found via alignment with a reference genome).
  • describe-feature.py - print information about a given feature or features.
  • describe-genome.py - extract nucleotide and/or amino acid sequences for features and summarize their similarity.
  • describe-site.py - print information about particular genome locations.

The various describe-*.py scripts will extract information about just the reference sequence if no unannotated genome is given. This can be used, for example, to obtain an absolute nucleotide offset in a reference given a relative amino acid offset for a particular gene (see examples below).

Terminology, conventions, and SARS-CoV-2 functionality

Genome locations: sites vs offsets

When referring to locations within a genome or a genome feature (e.g., a particular protein), "site" is used to describe 1-based locations, as would normally be used by a regular person. Therefore, the input and output of command-line scripts use 1-based numbering by default.

However, the library API, as used by Python programmers, expects and returns 0-based offsets.

The "site" and "offset" terminology is used consistently throughout the code.

Features

GenBank annotation files indicate the genome locations of "features". These are just genome regions. Although annotated features of interest are often ORFs or genes, they also include untranslated regions and many other. The gb2seq code that reads GenBank files uses this general term too, as you will see in the examples below.

Function argument and return value order

In all Python functions that deal with both a reference and an unannotated genome sequence, the reference is always passed and/or returned first.

Historical note on working with SARS-CoV-2 genomes

This code was written in late 2020 for processing SARS-CoV-2 genomes. It has since been generalized to allow any GenBank file as a reference.

The command-line scripts can be given a --sars2 to have them use the Wuhan reference (NC_045512), in which case there is no need to provide a GenBank reference file. Similarly, the Python classes can take a sars2 argument with the same effect.

If you are not working with SARS-CoV-2 genomes, just pass a GenBank file for your reference genome to the command-line scripts (via --reference) or to Python library functions.

Alignment algorithms and speed

gb2seq makes an alignment between the reference sequence and to any unannotated genome(s) you give it.

The default alignment algorithm is MAFFT, which you will need to have installed in a directory in your shell's PATH.

MAFFT can can be slow under some circumstances. So you can also run scripts with --aligner edlib (or pass aligner='edlib' to library functions) to use the Python wrapper for the fast edlib library. edlib should probably be the default.

Utility scripts

The scripts described below all accept a --help option. Below is some representative usage.

describe-feature.py

The simplest script is describe-feature.py, which can be used to get information about genome features.

If you give no arguments (other than indicating the reference genome), it will print summary details of all features, with their (1-based) nucleotide sites. If you want zero-based offsets, use --zeroBased.

$ describe-feature.py --sars2
Features for NC_045512.2:
2'-O-ribose methyltransferase:
  start: 20658
  stop: 21552
  length: 894
  product: 2'-O-ribose methyltransferase
  sequence    (len   894 nt): TCTAGTCAAGCGTGGCAACCGGGTGTTGCTATGCCTAATCTTTACAAAA...
3'-to-5' exonuclease:
  start: 18040
  stop: 19620
  length: 1581
  product: 3'-to-5' exonuclease
  sequence    (len  1581 nt): GCTGAAAATGTAACAGGACTCTTTAAAGATTGTAGTAAGGTAATCACTG...
3'UTR:
  start: 29675
  stop: 29903
  length: 229
  sequence    (len   229 nt): CAATCTTTAATCAGTGTGTAACATTAGGGAGGACTTGAAAGAGCCACCA...
# [Many additional output lines omitted here.]

You can specify a feature name (or names):

$ describe-feature.py --sars2 --name spike
surface glycoprotein:
  start: 21563
  stop: 25384
  length: 3822
  product: surface glycoprotein
  sequence    (len  3822 nt): ATGTTTGTTTTTCTTGTTTTATTGCCACTAGTCTCTAGTCAGTGTGTTA...
  translation (len  1274 aa): MFVFLVLLPLVSSQCVNLTTRTQLPPAYTNSFTRGVYYPDKVFRSSVLH...

And you can pass an unannotated genome to get information on the feature in the reference and the genome (which will be aligned to the reference). The position and length of the feature in the unannotated genome may of course differ from the reference:

$ describe-feature.py --name spike --sars2 --genome ChVir9290.fasta
Reference:
  surface glycoprotein:
    start: 21563
    stop: 25384
    length (nt): 3822
    product: surface glycoprotein
    note: structural protein; spike protein
    feature is translated left-to-right.
    sequence: ATGTTTGTTTTTCTTGTTTTATTGCCACTAGTCTCTAGTCAGTGTGTTAATCTTACAACCAGAACTCAATTACCCCCTGC...
    length (aa): 1274
    translation: MFVFLVLLPLVSSQCVNLTTRTQLPPAYTNSFTRGVYYPDKVFRSSVLHSTQDLFLPFFSNVTWFHAIHVSGTNGTKRFD...
  Genome BetaCoV/Rendsburg-Eckernfoerde/ChVir9290/2020:
    start: 21550
    stop: 25366
    length (nt): 3822
    sequence: ATGTTTGTTTTTCTTGTTTTATTGCCACTAGTCTCTAGTCAGTGTGTTAATCTTACAACCAGAACTCAATTACCCCCTGC...
    translation: MFVFLVLLPLVSSQCVNLTTRTQLPPAYTNSFTRGVYYPDKVFRSSVLHSTQDLFLPFFSNVTWFHAISGTNGTKRFDNP...

Or you can use --names to get a list of all feature names. If --sars2 is used, names are printed followed by a colon and a (possibly empty) list of aliases:

$ describe-feature.py --sars2 --names
2'-O-ribose methyltransferase: 2
3'-to-5' exonuclease: exon, exonuclease, nsp14
3'UTR: 3utr
3C-like proteinase: 3clpro, mpro, nsp5
5'UTR: 5utr
endoRNAse: endornase, nsp15
envelope protein: e, envelope, orf4
helicase: nsp13
leader protein: leader, nsp1
membrane glycoprotein: m, membrane, orf5
nsp2:
nsp3:
nsp4:
nsp6:
nsp7:
nsp8:
nsp9:
nsp10:
nsp11:
nucleocapsid phosphoprotein: n, orf9
ORF1ab polyprotein: orf1ab
ORF1a polyprotein: orf1a
ORF3a protein: orf3a
ORF6 protein: orf6
ORF7a protein: orf7a
ORF7b: orf7b
ORF8 protein: orf8
ORF10 protein: orf10
RNA-dependent RNA polymerase: nsp12, rdrp
stem loop 1: sl1
stem loop 2: sl2
stem loop 3: sl3
stem loop 4: sl4
stem loop 5: sl5
surface glycoprotein: s, spike

There is a --sortBy option for sorting the order of the reported features. The default is the order they are given on the command line. Other options are --sortBy name and --sortBy site (i.e., increasing genome start position).

describe-site.py

Prints information about a given location in the genome, showing you what's in the reference and the unannotated genome you (optionally) pass.

In the simplest case, give a (1-based) site number and you'll see what's at that location in the reference. The output shows 1-based sites. Use --zeroBased to get 0-based offsets.

$ describe-site.py --sars2 --site 26000
{
    "alignmentOffset": 26000,
    "featureName": "ORF3a protein",
    "featureNames": [
        "ORF3a protein"
    ],
    "reference": {
        "aa": "L",
        "aaOffset": 202,
        "codon": "TTA",
        "frame": 1,
        "id": "NC_045512.2",
        "ntOffset": 26000
    }
}

At the moment, the output is a JSON object, though this may someday change to a more verbose/readable form. Use --json to make sure you always get JSON.

You can also specify the site number relative to a feature:

$ describe-site.py --sars2 --site 1501 --feature spike --relative
{
    "alignmentOffset": 23063,
    "featureName": "surface glycoprotein",
    "featureNames": [
        "surface glycoprotein"
    ],
    "reference": {
        "aa": "N",
        "aaOffset": 500,
        "codon": "AAT",
        "frame": 0,
        "id": "NC_045512.2",
        "ntOffset": 23063
    }
}

Or pass an amino acid site number (via --aa):

$ describe-site.py --sars2 --site 501 --feature spike --relative --aa
{
    "alignmentOffset": 23063,
    "featureName": "surface glycoprotein",
    "featureNames": [
        "surface glycoprotein"
    ],
    "reference": {
        "aa": "N",
        "aaOffset": 500,
        "codon": "AAT",
        "frame": 0,
        "id": "NC_045512.2",
        "ntOffset": 23063
    }
}

Of course it's more fun if you also provide an unannotated genome to compare the reference to. Here's the N501Y change in a SARS-CoV-2 B.1.1.7 (Alpha variant) sequence:

$ describe-site.py --sars2 --site 501 --relative --genome gb2seq/data/EPI_ISL_601443.fasta \
    --feature spike --aa
{
    "alignmentOffset": 23063,
    "featureName": "surface glycoprotein",
    "featureNames": [
        "surface glycoprotein"
    ],
    "genome": {
        "aa": "Y",
        "aaOffset": 497,
        "codon": "TAT",
        "frame": 0,
        "id": "EPI_ISL_601443 hCoV-19/England/MILK-9E05B3/2020",
        "ntOffset": 22991
    },
    "reference": {
        "aa": "N",
        "aaOffset": 500,
        "codon": "AAT",
        "frame": 0,
        "id": "NC_045512.2",
        "ntOffset": 23063
    }
}

Other options include --genomeAaOnly to just print the amino acid at a location in the genome, --includeFeature to also receive information about the feature at the site, and --minReferenceCoverage to exclude low-coverage genomes or features from the results.

describe-genome.py

describe-genome.py has many uses. It can extract multiple features from multiple given genomes, as amino acids or nucleotides or both. It will print to standard output by default, but if you use the --outDir option to provide a directory, individual output files with (hopefully) self-explanatory names will be created in that directory. The directory will be created for you if it doesn't exist.

A small example is perhaps best. Here we extract the spike nucleotide and amino acid sequence from B.1.1.7 and also ask for a summary of the amino acid differences:

$ describe-genome.py --sars2 --genome gb2seq/data/EPI_ISL_601443.fasta --outDir /tmp/out \
    --feature spike --printNtSequence --printAaSequence --printAaMatch
Examined 1 genome.

$ ls -l /tmp/out
total 24
-rw-rw-r--  1 terry  wheel   748 Apr 11 15:25 EPI_ISL_601443-spike-aa-match.txt
-rw-rw-r--  1 terry  wheel  1344 Apr 11 15:25 EPI_ISL_601443-spike-aa-sequence.fasta
-rw-rw-r--  1 terry  wheel  3886 Apr 11 15:25 EPI_ISL_601443-spike-nt-sequence.fasta

If the file given by --genome had contained more than one SARS-CoV-2 genome, the spike would have been extracted for all of them. Similarly, if --feature had been repeated, multiple features would have been extracted and compared. If no --feature is given, you'll get them all.

$ cat /tmp/out/EPI_ISL_601443-spike-aa-match.txt
Feature: spike amino acid match
  Matches: 1264/1274 (99.22%)
  Mismatches: 10/1274 (0.78%)
    Not involving gaps (i.e., conflicts): 7/1274 (0.55%)
    Involving a gap in one sequence: 3/1274 (0.24%)
    Involving a gap in both sequences: 0
    Id: NC_045512.2 (surface glycoprotein)
      Length: 1274
      Gaps: 0
    Id: EPI_ISL_601443 hCoV-19/England/MILK-9E05B3/2020 (surface glycoprotein)
      Length: 1274
      Gaps: 3/1274 (0.24%)
      Gap locations (1-based): 69, 70, 144
    Differences: site, aa1, aa2, ref nt codon start
        69 H - 21767
        70 V - 21770
       144 Y - 21992
       501 N Y 23063
       570 A D 23270
       614 D G 23402
       681 P H 23603
       716 T I 23708
       982 S A 24506
      1118 D H 24914

You can also ask for the changes in a variant to be checked.

$ describe-genome.py --sars2 --genome gb2seq/data/EPI_ISL_601443.fasta --checkVariant VOC_20201201_UK
EPI_ISL_601443 hCoV-19/England/MILK-9E05B3/2020
Variant summary:
  UK variant of concern (VOC) 202012/01:
  20 checks, 20 passed.
    orf1ab aa: PASS: 1001I, 1708D, 2230T, 3675-, 3676-, 3677-
    spike aa: PASS: 1118H, 144-, 501Y, 570D, 681H, 69-, 70-, 716I, 982A
    orf8 aa: PASS: 52I, 73C, Q27*
    n aa: PASS: 235F, 3L

There are some known variants, and you can also provide your own via a JSON file and the --variantFile option. Your JSON should have the format you'll see in variants.py. E.g.,:

VARIANTS = {
    'VOC_20201201_UK': {
        'description': 'UK variant of concern (VOC) 202012/01',
        'comment': ('From Table 1 of https://www.gov.uk/government/'
                    'publications/investigation-of-novel-sars-cov-2'
                    '-variant-variant-of-concern-20201201'),
        'changes': {
            'orf1ab': {
                'aa': '1001I 1708D 2230T 3675- 3676- 3677-',
            },
            'spike': {
                'aa': '69- 70- 144- 501Y 570D 681H 716I 982A 1118H',
            },
            'orf8': {
                'aa': 'Q27* 52I 73C',
            },
            'n': {
                'aa': '3L 235F',
            }
        }
    }
}

Instead of using specific features you can also use the --translated option to select all features that are translated (i.e. coding sequences).

annotate-genome.py

Produces JSON output with annotation information for a genome. Here's an example of the start of output for a Monkeypox genome (note that the nucleotide sequences have been truncated to reduce output width):

$ annotate-genome.py --aligner edlib --reference ON676708.1.gb --genome ChVir28389.fasta
{
    "features": {
        "A15.5L": {
            "genome": {
                "sequence": "ATGATAAGTAATTACGAGCCGTTGCTGCTGTTAGTTATAAC...",
                "start": 121823,
                "stop": 121985,
                "translation": "MISNYEPLLLLVITCCVLLFNFTISSKTKIDIIFAVQTIVFIWFIFHFVYSAI*"
            },
            "reference": {
                "forward": false,
                "name": "A15.5L",
                "note": "Non-essential IMV membrane protein (Cop-A14.5L)",
                "product": "A15.5L",
                "sequence": "TTAAATCGCCGAATAAACAAAGTGGAATATAAACCATATAA...",
                "start": 121759,
                "stop": 121921,
                "translation": "MISNYEPLLLLVITCCVLLFNFTISSKTKIDIIFAVQTIVFIWFIFHFVYSAI*"
            }
        },
        "A32.5L": {
            "genome": {
                "sequence": "ATGTTAAAAATGTCAGCTGCCGACTTTTTGGAACGTTTGAT...",
                "start": 139696,
                "stop": 139825,
                "translation": "MLKMSAADFLERLIKAGIYIYVLRTKYVITALLVKNYPIKDE*"
            },
            "reference": {
                "forward": false,
                "name": "A32.5L",
                "note": "Viral membrane assembly proteins (VMAP) (Cop-A 30.5L)",
                "product": "A32.5L",
                "sequence": "TTATTCGTCTTTTATGGGATAGTTTTTAACTAGTAAAGCTGTAA...",
                "start": 139635,
                "stop": 139764,
                "translation": "MLKMSAADFLERLIKAGIYIYVLRTKYVITALLVKNYPIKDE*"
            }
        },
}

The output JSON is not really intended for human consumption and, for now, always contains 0-based genome offsets.

Python API

There are two main Python classes provided by gb2seq: Features and Gb2Alignment.

Features

The Features class provides methods for accessing information about genome features obtained from a GenBank flat file.

You've likely run across these records before. E.g., here's the SARS-CoV-2 Wuhan reference, NC_045512. To download the GenBank file for that reference from the NCBI site, click on "Send to" and select "Complete Record", "File", and "GenBank" format. Then click "Create File".

You can pass the path to a GenBank file to the Features class. You can also just pass an accession number, and the file will be downloaded for you. If you pass referenceSpecification as None and sars2 as True, the Wuhan reference (version NC_045512.2) will be used.

You can use a Features instance like a dictionary:

from pprint import pprint as pp
from gb2seq.features import Features

>>> f = Features("NC_045512.2.gb")
>>> pp(f['e'])
{'name': 'envelope protein',
 'note': 'ORF4; structural protein; E protein',
 'product': 'envelope protein',
 'sequence': 'ATGTACTCATTCGTTTCGGAAGAGACAGGTACGTTAATAGTTAATAGCGTACTTCTTTTTCTTGCTTTCGTGGTATT...',
 'start': 26244,
 'stop': 26472,
 'translation': 'MYSFVSEETGTLIVNSVLLFLAFVVFLLVTLAILTALRLCAYCCNIVNVSLVKPSFYVYSRVKNLNSSRVPDLLV*'}

# You can use abbreviated names, and get the canonical names:
>>> f.canonicalName('s')
'surface glycoprotein'

# Get the list of aliases for a name:
>>> f.aliases('s')
{'spike', 'surface glycoprotein', 's'}

# Given an offset relative to a feature, get the offset in the genome:
>>> f.referenceOffset('spike', 1503)
23065

# Same thing, but with an amino acid offset.
>>> f.referenceOffset('spike', 501, aa=True)
23065

# What features are present at an offset?
>>> f.getFeatureNames(13450)
{'ORF1ab polyprotein', 'nsp11', 'ORF1a polyprotein', 'RNA-dependent RNA polymerase'}

# What features are present at an offset, including those that are not translated?
>>> f.getFeatureNames(21000, includeUntranslated=True)
{'ORF1ab polyprotein', "2'-O-ribose methyltransferase"}

Gb2Alignment

The Gb2Alignment class can be used to extract and compare features from the reference and the given genome sequence.

You pass it a Read instance from the dark-matter module (which is installed for you when you install gb2seq).

from gb2seq.alignment import Gb2Alignment
from gb2seq.features import Features
from dark.reads import Read

features = Features("NC_045512.2.gb")
alignment = Gb2Alignment(Read('id', 'AGCT...'), features)

These can also be read from a FASTA file:

from gb2seq.alignment import Gb2Alignment
from gb2seq.features import Features
from dark.fasta import FastaReads

features = Features("NC_045512.2.gb")
for read in FastaReads('sequences.fasta'):
    alignment = Gb2Alignment(read, features)

Once you have a Gb2Alignment instance, you can ask it for aligned sequences or features.

Below I'll use the GISAID EPI_ISL_601443 (B.1.1.7, or Alpha, variant) sequence, which you can find in gb2seq/data/EPI_ISL_601443.fasta in this repo:

>>> from pathlib import Path
>>> from pprint import pprint as pp
>>> from gb2seq.alignment import Gb2Alignment
>>> from gb2seq.features import Features
>>> from dark.fasta import FastaReads

>>> alpha = list(FastaReads(Path('gb2seq/data/EPI_ISL_601443.fasta')))[0]
>>> len(alpha)
29764
>>> alpha.id
'EPI_ISL_601443 hCoV-19/England/MILK-9E05B3/2020'
>>> alpha.sequence[:50]
'AGATCTGTTCTCTAAACGAACTTTAAAATCTGTGTGGCTGTCACTCGGCT'

>>> features = Features(sars2=True)
>>> alignment = Gb2Alignment(alpha)

You'll find the aligned reference and genome in alignment.referenceAligned and alignment.genomeAligned, both of which are Read instances:

>>> len(alignment.referenceAligned)
29903
>>> len(alignment.genomeAligned)
29903

# Get the nucleotide sequence for the spike protein for the reference and genome.
>>> referenceSpikeNt, genomeSpikeNt = alignment.ntSequences('spike')
>>> len(referenceSpikeNt)
3822

# Get the amino acid sequence for the spike protein for the reference and genome.
>>> referenceSpikeAa, genomeSpikeAa = alignment.aaSequences('spike')
>>> len(referenceSpikeAa)
1274

# There were three deletions in the alpha spike, so it only covers 3813 of the
# 3822 bases in the reference spike.
>>> alignment.coverage('s')
(3813, 3822)

# Get information about what's at an offset (0-based). This is what the describe-site.py
# utility does (though it takes a 1-based site).
#
# Here is the Alpha N501Y change:
>>> pp(alignment.offsetInfo(500, relativeToFeature=True, aa=True, featureName='s'))
{'featureName': 'surface glycoprotein',
 'featureNames': {'surface glycoprotein'},
 'alignmentOffset': 23062,
 'reference': {'aa': 'N',
  'codon': 'AAT',
  'frame': 0,
  'id': 'NC_045512.2',
  'aaOffset': 500,
  'ntOffset': 23062},
 'genome': {'aa': 'Y',
  'codon': 'TAT',
  'frame': 0,
  'id': 'EPI_ISL_601443 hCoV-19/England/MILK-9E05B3/2020',
  'aaOffset': 497,
  'ntOffset': 22990}}

You can check a feature for an expected change:

>>> alignment.checkFeature('spike', 'N501Y', aa=True)
(1, 0, {'N501Y': (True, 'N', True, 'Y')})

The return value gives the number of tests done (1), the number that failed (0), and a dict with information about each test. The dict values are 4-tuples, indicating whether what was in the reference was as expected (True), the value in the reference (N), whether what was in the genome was as expected (True), the value in the genome (Y).

You can test multiple things:

# Note that we use 501Y in the following, not N501Y, since we might just
# want to check that something is in the genome without knowing or caring
# about what's in the reference.
>>> pp(alignment.checkFeature('spike', '501Y 69- 70-', aa=True))
(3,
 0,
 {'501Y': (True, 'N', True, 'Y'),
  '69-': (True, 'H', True, '-'),
  '70-': (True, 'V', True, '-')})

There is also a convenience Checker class that can check whether logical combinations of amino acid and nucleotide changes are satisfied for a genome. Continuing from the above:

>>> from gb2seq.checker import AAChecker, NTChecker

# Make a Boolean checker function to test whether a genome has the N501Y
# and A570D spike changes seen in Alpha.
>>> checker = AAChecker('spike', 'N501Y') & AAChecker('spike', 'A570D')
>>> checker(alignment)
True

# Check for some nucleotide changes in the nucleocapsid and some amino
# acid changes in the spike.
checker = (NTChecker('N', 'G7C A8T T9A G608A G609A G610C C704T') &
           AAChecker('S', 'N501Y H69- V70- Y144-'))

# You can also use `|` to check an OR condition.
>>> checker = AAChecker('spike', 'E484K') | AAChecker('spike', 'E484Q')
>>> checker(alignment)
False

Note that because the Checker class takes a string argument that likely originates from a human-readable source, e.g., "N501Y", the changes specified for the checker are in terms of 1-based sites.

Similiar to the --checkVariant argument to describe-genome.py (above), you can also check a pre-defined variant:

>>> pp(alignment.checkVariant('VOC_20201201_UK'))
(20,
 0,
 {'n': {'aa': {'235F': (True, 'S', True, 'F'), '3L': (True, 'D', True, 'L')}},
  'orf1ab': {'aa': {'1001I': (True, 'T', True, 'I'),
                    '1708D': (True, 'A', True, 'D'),
                    '2230T': (True, 'I', True, 'T'),
                    '3675-': (True, 'S', True, '-'),
                    '3676-': (True, 'G', True, '-'),
                    '3677-': (True, 'F', True, '-')}},
  'orf8': {'aa': {'52I': (True, 'R', True, 'I'),
                  '73C': (True, 'Y', True, 'C'),
                  'Q27*': (True, 'Q', True, '*')}},
  'spike': {'aa': {'1118H': (True, 'D', True, 'H'),
                   '144-': (True, 'Y', True, '-'),
                   '501Y': (True, 'N', True, 'Y'),
                   '570D': (True, 'A', True, 'D'),
                   '681H': (True, 'P', True, 'H'),
                   '69-': (True, 'H', True, '-'),
                   '70-': (True, 'V', True, '-'),
                   '716I': (True, 'T', True, 'I'),
                   '982A': (True, 'S', True, 'A')}}})

with the results summarizing the number of tests done, the number that failed, and then the features checked, with aa and nt dictionaries for the amino acid and nucleotide checks.

You can pass your own variant dictionary specifying what you want checked.

To learn more

See the Features and Gb2Alignment classes in gb2seq/feature.py and gb2seq/alignment.py. Also, the tests (e.g., in test/test_feature.py, test/test_alignment.py, test/test_checker.py test/test_variants.py) show you example uses of these classes and their methods. You can also look to see how the three utility scripts described above (which can all be found in the bin directory) call the library functions and use the results.

Developing

Run the tests via

$ pytest

Notes

  • The tests will run MAFFT, so you need that installed and in your shell's PATH.
  • The tests run slowly (18 seconds on my laptop) due to the default use of MAFFT.
  • The tests do not all pass if you set DEFAULT_ALIGNER to be "edlib" in gb2seq/alignment.py. This is because MAFFT and edlib produce slightly different results and some tests of the SARS-CoV-2 spike translation tests fail as a result. I would like to post-process the edlib output to match that of MAFFT (this is in cases where there are multiple equally-good alignments).