CFEIntact is BCCfE's version of HIVIntact -- an automated proviral intactness checker for HIV-1 consensus sequences, developed in Python. It enables researchers and clinicians to analyze HIV-1 sequences for intactness, aiding in the understanding of viral replication and persistence.
- Automated Analysis: Simplifies the process of checking HIV-1 consensus sequences for intactness with automated tools.
- Extensible: Designed to be extendable with additional checks and features as the field of HIV research evolves.
- Free software: Encourages contributions and improvements from the community to make the tool more accurate and robust.
The easiest way to install and run CFEIntact is through Docker. The pre-built Docker image is available on Docker Hub.
Ensure Docker is installed on your system. You can download and install Docker from the official Docker website.
Once Docker is installed, pull the docker image from Docker Hub:
docker pull cfelab/cfeintactTo verify the installation, run:
docker run --rm cfelab/cfeintact versionThis command should print something like 1.23.2.
Assuming you have a file called sequences.fasta in the current directory.
Then to analyze a set of FASTA sequences that are included in that file, run:
docker run --rm -v .:/w cfelab/cfeintact check --subtype B --ignore-distance sequences.fastaThis command mounts the current directory to /w in the container, making your local files accessible. Be sure to adjust the command for your specific analysis (e.g., sequences.fasta is your input file).
Note: currently it is recommended to use subtype B even if your sequences are not subtype B. This is because many well known sequences of reference subtypes, which CFEIntact uses in its analysis, contain serious defects. We track this issue here.
Refer to the project's website for comprehensive documentation, including setup, usage examples, and development guidelines.
CFEIntact originated as a fork of HIVIntact, initially developed by Imogen Wright et al. This project owes its foundational concept to the original work and appreciates the efforts put in by the original team in advancing the field of HIV research.
However, over time, CFEIntact has undergone significant modifications and enhancements to better meet our evolving needs. These changes have led the project to diverge in ways that the original HIVIntact paper no longer accurately describes the forked version. CFEIntact has introduced new features, optimizations, and methodologies that are distinct from its origin, catering to a broader spectrum of analyses.
We encourage users and contributors to view CFEIntact as an extension and evolution of the ideas first introduced in HIVIntact, adjusted and expanded upon to serve contemporary research purposes.
We welcome contributions to CFEIntact! Whether you're fixing a bug, adding a new feature, or improving the documentation, your help makes CFEIntact better for everyone.
CFEIntact is MIT licensed.