Skip to main content

cgat : the Computational Genomics Analysis Toolkit

Project description

Documentation Status Github Action status

CGAT Apps

CGAT Apps is a collection of scripts to aid the analysis of high-throughput sequencing data.

After installation, use the cgat command to see how to use them.

Documentation

We are attempting to improve our documentation. However, our current documentation can be found here

For questions, please open a discussion on the GitHub issue page

Installation

Conda Installation

The preferred method to install CGAT Apps is using the installation script, which uses mamba, the fast C implementation of Conda.

To install cgat-apps using mamba::

mamba install -c conda-forge -c bioconda cgat-apps

Developers: try the installation script

Here are the steps::

    # Install conda and mamba according the the documentation. Next
    # install the conda packages for cgat-apps to work
    conda env create -f conda/environments/cgat-apps.yml

    # enable the conda environment
    conda activate cgat-a

    # Install the development version of cgat-apps
    python setup.py develop

    # finally, please run the cgat command-line tool to check the installation:
    cgat --help

The installation script will put everything under the specified location. The aim is to provide a portable installation that does not interfere with the existing software. As a result, you will get a conda environment working with CGAT Apps which can be enabled on demand according to your needs.

Usage

Run the cgat --help command to see what scripts are available and how to use them. For example, to strip sequence and quality information from a bam_ file, type::

cgat bam2bam --strip=sequence < in.bam > out.bam

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

cgat-0.7.10.tar.gz (419.7 kB view details)

Uploaded Source

File details

Details for the file cgat-0.7.10.tar.gz.

File metadata

  • Download URL: cgat-0.7.10.tar.gz
  • Upload date:
  • Size: 419.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.13

File hashes

Hashes for cgat-0.7.10.tar.gz
Algorithm Hash digest
SHA256 2519fd2a7b878f616af0e14c67029251f3e9807fa1abbe3b870bb345014bc03c
MD5 0434b663284f31757a00d01ecc2a8a40
BLAKE2b-256 9489d6d25b52fc4bd5f0291f0caa1aa607c4f54fce250e411ed0de06ac2f1221

See more details on using hashes here.

Supported by

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