Skip to main content

Explore nucleotide divergence and sequence resolution across user-defined categories.

Project description

CATnip Workflow

install with bioconda Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge

CATnip a tool to assess nucleotide divergence and sequence resolution between user-defined categories.

Prerequisites

  • Conda or Mamba
  • Git

Installation (Recommended)

Install CATnip directly from Bioconda:

conda create -n catnip -c conda-forge -c bioconda catnip-seq
conda activate catnip

Or faster with mamba:

mamba create -n catnip -c conda-forge -c bioconda catnip-seq

Development Installation

  1. Clone the repository:

    git clone https://github.com/CIBIO-BU/catnip
    cd catnip
    
  2. Create the conda environment:

    conda env create -f catnip-env.yml
    
  3. Activate the environment:

    conda activate catnip
    
  4. Install catnip command:

    pip install -e .
    
  5. Check help message:

    catnip -h
    
  6. Run the test workflow:

    cd test-workflow
    catnip -i coi_micointf_mil.fasta -f coi_micointf_mil_mapping.tsv -c 0,1,2,3 -p 10
    

Environment Details

The conda environment includes:

  • Python 3.11
  • CD-HIT 4.8.1 (sequence clustering)
  • Bowtie2 2.5.4 (sequence alignment)
  • SAMtools (BAM/SAM file processing)
  • pysam (Python interface for SAM/BAM files)
  • pandas & numpy (data analysis)

Documentation

Divergence values are rounded to the NEAREST WHOLE VALUE. However, output is presented with one decimal case.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

catnip_seq-0.1.9.tar.gz (26.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

catnip_seq-0.1.9-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

Details for the file catnip_seq-0.1.9.tar.gz.

File metadata

  • Download URL: catnip_seq-0.1.9.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for catnip_seq-0.1.9.tar.gz
Algorithm Hash digest
SHA256 4df91ebae954b16722cd04dcb52b0d5a05a328fc3fc21289aad72151fedae49b
MD5 e9b60692916569370f87c1679fbc9176
BLAKE2b-256 0a09bae5c51bf9a04c12d4a340fe947767b15c96b4661733f27f38e52ad02296

See more details on using hashes here.

File details

Details for the file catnip_seq-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: catnip_seq-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 29.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for catnip_seq-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 b6686cbc86a362a6004437800099054a88443fea04ff99dee2e5a71dafe8315b
MD5 86468e94259e32eda577de05beacb39c
BLAKE2b-256 8e2fb8e4df0809a19e087f3bae55d781b0de851ac115383e22e914148e2f4964

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page