Squidward

This release marks a significant milestone in enhancing our tool’s precision and robustness. Our team has focused on refining key algorithms, improving defect messaging, and standardizing output formats while maintaining tight integration with third‐party alignment and BLAST tools. This is still CFEIntact version 1, codename "Squidward."

New Features and Improvements

• Defects and Output Files

  • The internal defect classes have been renamed and improved for clarity. For example, "DeletionInOrf" and "InsertionInOrf" are now simply "Deletion" and "Insertion" (and additional changes in start/stop defect names).
  • The defect messages have been refined to include more precise language (for example, reporting exactly the number of insertions/deletions relative to the accepted tolerance).
  • In outputs the "errors" file has been renamed to "defects", and field names (e.g. "code", "message", and "region") have been updated accordingly.
  • Output CSV (or JSON) now uses a "regions" file that holds ORF/region information along with holistic information and defects; fields coming from the FoundORF structure have been expanded to now include subtype start/end values plus aminoacid and nucleotide representations.

• ORF Detection & Alignment Enhancements

  • Improvements in the ORF detection algorithm (e.g. changes in how candidate positions are computed, using the translation table and "biggest protein" detection) help improve precision.
  • Small refinements in the calculation of the reading frame, handling of frameshifts, and the computation of indel impact contribute to a more accurate intactness determination.

• Code Robustness and Error Handling

  • In the "wrappers" module (both MAFFT and BLAST calls), additional exception handling has been added. Now, if a third‐party tool fails (or is interrupted), a clear UserError is raised with guidance on how to check the FASTA file formatting.
  • The get_biggest_protein function has been reworked to allow for better detection of the longest valid translated region based on whether a start codon is required.

• Dependency and Build Process Enhancements

  • GitHub workflows have been updated to upgrade pip automatically before installation.
  • The Dockerfile now sets a fixed working directory to /w.
  • The docs' Dockerfile and gitignore have been slightly reworked for clarity and consistency.

Breaking Changes and Impact for Users

• Defect Messages and Terminology

  • The printed messages in defect objects have changed. If you rely on parsing specific strings from CFEIntact output (for example, "DeletionInOrf" is now "Deletion", "InternalStopInOrf" is now "InternalStop", etc.), please update your downstream tools and scripts accordingly.
  • The field "error" in the output files is now replaced by "code," and the "orf" field is now "region."

• Output File Names

  • Previously the GitHub tests expected an "errors.csv" file; it is now written as "defects.csv."
  • The overall "orfs" output is now published as "regions.csv." If you have any automation or custom reporting that relies on these filenames or header fields, please update them.

• API and Command‐Line Changes

  • The command "cfeintact check" now by default tests for defects using the updated messages and writes a "defects.csv" file.
  • In GitHub workflow and Docker run commands, flags (e.g. "--ignore-distance" and "--ignore-packaging-signal") remain the same, but tests have been updated so that the existence of "defects.csv" is verified rather than "errors.csv."

Documentation, Examples, and Further Notes

• Updated documentation pages now include revised navigation (with an updated Quick Start that adds an "Installation" and "Data Preparation" section), so users and developers should refer to the online docs for the latest instructions.
• The release notes note that output fields and defect messages have changed --- if you integrate CFEIntact in automated workflows, please verify that your parsing scripts (or Codecov integrations) work with the new structure.

Summary

This release includes "small improvements and fixes" with notable enhancements to defect detection messages, output file structure, and precision in ORF analysis. While these changes improve overall usability and accuracy, they may require adjustments for users relying on previously defined output formats and error message contents.

Full Changelog: v1.18.8...v1.23.2

v1.18.8

Full Changelog: v1.18.7...v1.18.8

Stable release 1

Full Changelog: v1.8.0...v1.18.7

Initial release

The first release after renaming the project.