add --check-unknown-nucleotides flag

cfe-lab · Feb 16, 2024 · 5580125 · 5580125
1 parent 975a58d
commit 5580125
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/bin/proviral.py b/bin/proviral.py
@@ -53,6 +53,9 @@ def cli():
 @click.option(
     '--check-internal-inversion/--ignore-internal-inversion', default=False
 )
+@click.option(
+    '--check-unknown-nucleotides/--ignore-unknown-nucleotides', default=True
+)
 @click.option(
     '--include-small-orfs/--exclude-small-orfs', default=False)
 @click.option(
@@ -65,7 +68,7 @@ def cli():
 def intact(input_file, subtype, include_packaging_signal,
            include_rre, check_major_splice_donor_site, run_hypermut,
            check_long_deletion, check_nonhiv, check_scramble, check_internal_inversion,
-           include_small_orfs, output_csv, working_folder):
+           check_unknown_nucleotides, include_small_orfs, output_csv, working_folder):
     """
     Check consensus sequences for intactness.
     """
@@ -77,7 +80,7 @@ def intact(input_file, subtype, include_packaging_signal,
         folder, input_file, subtype, include_packaging_signal, include_rre,
         check_major_splice_donor_site, run_hypermut,
         check_long_deletion, check_nonhiv, check_scramble, check_internal_inversion,
-        include_small_orfs, output_csv
+        check_unknown_nucleotides, include_small_orfs, output_csv
     )
 
 if __name__ == "__main__": cli()
diff --git a/intact/intact.py b/intact/intact.py
@@ -711,6 +711,7 @@ def intact( working_dir,
             check_nonhiv,
             check_scramble,
             check_internal_inversion,
+            check_unknown_nucleotides,
             include_small_orfs,
             output_csv,
             hxb2_forward_orfs = const.DEFAULT_FORWARD_ORFs,
@@ -747,9 +748,10 @@ def analyse_single_sequence(writer, sequence, blast_rows):
                 for subseq in invalid_subsequences
             )
 
-            err = IntactnessError(sequence.id, UNKNOWN_NUCLEOTIDE,
-                                  f'Sequence contains invalid nucleotides: {error_details}')
-            sequence_errors.append(err)
+            if check_unknown_nucleotides:
+                err = IntactnessError(sequence.id, UNKNOWN_NUCLEOTIDE,
+                                      f'Sequence contains invalid nucleotides: {error_details}')
+                sequence_errors.append(err)
 
             sequence = SeqRecord.SeqRecord(
                 Seq.Seq(''.join(x for x in sequence.seq if x in VALID_DNA_CHARACTERS)),

diff --git a/tests/test_end_to_end.py b/tests/test_end_to_end.py
@@ -19,6 +19,7 @@ def run_end_to_end(tmp_path, data_file, expected_dir, subtype, output_csv):
         check_nonhiv=True,
         check_scramble=True,
         check_internal_inversion=True,
+        check_unknown_nucleotides=True,
         include_small_orfs=True,
         output_csv=output_csv,
         )