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)

Implementation Details

  • Divergence values are rounded to the NEAREST WHOLE VALUE. However, output is presented with one decimal case.
  • Taxa absent from the output file were excluded from the alignment step, as they can be reliably distinguished from all other taxa in the dataset based on the input divergence thresholds.

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.10.tar.gz (27.0 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.10-py3-none-any.whl (29.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: catnip_seq-0.1.10.tar.gz
  • Upload date:
  • Size: 27.0 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.10.tar.gz
Algorithm Hash digest
SHA256 9a09af1d2130aa55c7bdda9d9f2e1f332b46fea16f2307e94ac9c1ad24e77bc1
MD5 edd60e3a76fbf1541fe4ea2aa42f49c0
BLAKE2b-256 eb2ae6f4286a28c85c7b1384c159cfcb2ffa6526ae3ea6c640fc0b415956eefb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: catnip_seq-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 29.2 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 1a1c0c1082bf8ea16f10f12e3f3f0709300e3a62e59f67c87260e549bd7c98d0
MD5 62137c4376708a561e0e56db8a7ec55f
BLAKE2b-256 c71e78c5c6696ca024c5929c6f9c1e9daffac90d31645527e42e2c2fdd216f1b

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