a3partitioner

A bioinformatics tool for creating APOBEC3 and non-APOBEC3 partitions from sequence alignments.

https://github.com/daanjansen94/a3partitioner

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A bioinformatics tool for creating APOBEC3 and non-APOBEC3 partitions from sequence alignments.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 2
Created about 1 year ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

A3Partitioner

A bioinformatics tool for creating APOBEC3 and non-APOBEC3 partitions from sequence alignments. For generating a quick and reliable MPXV alignment for both clades, we refer to squirrel.

Background

Literature indicates that an overwhelming majority of mutations found in monkeypox viral genomes are a result of deaminase editing, which provides a distinct APOBEC3 signature in the genomes (doi: 10.1126/science.adg8116). When performing evolutionary analysis of MPXV on relatively short timescales, it is therefore unlikely that a significant number of non-APOBEC3 mutations, which arise from error-prone polymerases, will accumulate. Given this, one can extract the APOBEC3 partition from the nucleotide alignment and perform phylogenetic analysis with this partition to exclude bias from artificially introduced mutations (e.g., sequencing or bioinformatics errors).

How It Works

This tool creates two distinct partitions from a nucleotide alignment:

  1. APOBEC3 Partition:

    • Includes sites with putative APOBEC3 modifications (C → T or G → A substitutions in specific dinucleotide contexts)
    • All other sites are masked as ambiguous nucleotides
    • Can be used as input for ML or Bayesian phylogenetic analyses, aiming to remove bias from artificially introduced mutations
  2. Non-APOBEC3 Partition:

    • Contains all sites except those with APOBEC3 target sites
    • APOBEC3 target sites are masked
    • Serves as a complement to the first partition

Installation

Option 1: Using Conda

First, ensure you have the required channels:

bash conda config --add channels defaults conda config --add channels bioconda conda config --add channels conda-forge

Then install A3Partitioner:

bash conda create -n a3partitioner -c bioconda a3partitioner -y conda activate a3partitioner

Option 2: From Source Code

Before installing from source, ensure you have: 1. Python 3.6 or higher installed bash # Check your Python version python3 --version

  1. Biopython package installed bash # Install Biopython if you don't have it pip install biopython

Then install A3Partitioner:

bash git clone https://github.com/DaanJansen94/a3partitioner cd a3partitioner ./install.sh

Usage

Options

  • -partition: Type of partition to create [apobec, non-apobec, both]
  • -i, --input: Input FASTA alignment file
  • -o, --output: Output FASTA file

Examples

  1. Create APOBEC3 partition: bash A3Partitioner -partition apobec -i input_aln.fasta -o output_aln.fasta

  2. Create non-APOBEC partition: bash A3Partitioner -partition non-apobec -i input_aln.fasta -o output_aln.fasta

  3. Create both partitions and analysis: bash A3Partitioner -partition both -i input_aln.fasta -o output_aln.fasta

Output Files

When using -partition both, the tool will create: - {output}_APOBEC3.fasta: APOBEC3 partition - {output}_non_APOBEC3.fasta: non-APOBEC3 partition

Citation

If you use a3partitioner in your research, please cite:

Jansen, D., & Vercauteren, K. (2025). a3partitioner: A bioinformatics tool for creating APOBEC3 and non-APOBEC3 partitions from sequence alignments (v.0.1.1). Zenodo. https://doi.org/10.5281/zenodo.14851870

License

This project is licensed under MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

If you encounter any problems or have questions, please open an issue on GitHub.

Owner

  • Login: DaanJansen94
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: 'If you use this software, please cite it as follows:'
authors:
  - family-names: Jansen
    given-names: Daan
    orcid: https://orcid.org/0000-0003-4612-6891
  - family-names: Vercauteren
    given-names: Koen
    orcid: https://orcid.org/0000-0003-1472-9938
doi: "10.5281/zenodo.14851870"
title: 'a3partitioner: A bioinformatics tool for creating APOBEC3 and non-APOBEC3 partitions from sequence alignments'
version: v0.1.0
url: https://github.com/DaanJansen94/a3partitioner
date-released: '2025-02-01'

GitHub Events

Total
  • Release event: 6
  • Delete event: 3
  • Push event: 61
  • Fork event: 1
  • Create event: 9
Last Year
  • Release event: 6
  • Delete event: 3
  • Push event: 61
  • Fork event: 1
  • Create event: 9

Dependencies

setup.py pypi
  • biopython >=1.80,<=1.90
.github/workflows/jekyll-gh-pages.yml actions
  • actions/checkout v4 composite
  • actions/configure-pages v5 composite
  • actions/deploy-pages v4 composite
  • actions/jekyll-build-pages v1 composite
  • actions/upload-pages-artifact v3 composite