CGAT - Computational Genomics Analysis Tools
Clone or download
sebastian-luna-valero Do not purge user modules during installation (#396)
*  do not purge user modules during installation

*  unset PYTHONPATH
Latest commit c77976a Jul 19, 2018
Permalink
Failed to load latest commit information.
CGAT release v0.3.3 May 25, 2018
R add cassi results format parsing May 23, 2017
conda/environments remove conda gcc May 17, 2018
dependency_graph update dependency graph Sep 25, 2015
doc release v0.3.3 May 25, 2018
galaxy added main() method to more scripts Aug 2, 2013
legacy code reorganization - created obsolet and legacy directories Aug 22, 2012
obsolete move bed_vs_bed.py to obsolete (#372) Nov 15, 2017
recipes {AH} update notebooks Apr 24, 2017
refactor fixed output-id option Nov 6, 2014
scripts Do not purge user modules during installation (#396) Jul 19, 2018
tests new method rename-chr for gff2gff.py (#390) Apr 6, 2018
.gitignore updated gitignore to ignore cmetrics.c Nov 23, 2015
.hgignore added Components to the repository May 3, 2013
.hgrc Changes to pipeline_exome.py and PipelineMappingQC Jun 19, 2013
.travis.yml pep8 and put TEST_IMPORT and TEST_STYLE back (#391) Apr 5, 2018
COPYING updates to documenation Sep 8, 2015
Dockerfile updated dockerfile to allow continuous deployment on docker hub Jun 17, 2015
INSTALL updated INSTALL text file Jun 19, 2015
KNOWN_BUGS rearranged repository May 3, 2013
LICENSE updated licence, added thanks Oct 4, 2013
MANIFEST.in {AH} set default options for cluster Jan 16, 2017
PKG-INFO rearranged repository May 3, 2013
README.rst Update installation (#373) Nov 16, 2017
THANKS.txt Ac update readme (#367) Nov 7, 2017
external_dependencies.txt added butter to external dependencies Feb 6, 2015
ez_setup.py setup.py - switched to setuptools Sep 12, 2013
install-CGAT-tools.sh Do not purge user modules during installation (#396) Jul 19, 2018
requires.txt {AH} update requirements to use pysam 0.10.0 Apr 3, 2017
setup.py {AH} move cgat.py to CGAT directory for py2/3 compatibility Oct 17, 2016
tox.ini {AH} use basepython without prefix Apr 3, 2017
update_cgat.py added update_cgat May 7, 2013

README.rst

https://travis-ci.org/CGATOxford/cgat.svg?branch=master https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat-square

The CGAT Code Collection

The CGAT Code Collection has two components. The first component is a collection of scripts in this repository, which are located here and can be run using the cgat command. Within this repository we also have a number of utility modules that help working with various file formats in Python. These are located here.

The second component is a collection of pipelines that utilise the functionality of the scripts and can be accessed here.

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

Documentation of CGAT tools is available here.

Installation

Install using Conda

The preferred method to install the CGAT code collection is using the installation script, which uses Conda.

Here are the steps:

# download installation script:
curl -O https://raw.githubusercontent.com/CGATOxford/cgat/master/install-CGAT-tools.sh

# see help:
bash install-CGAT-tools.sh

# install set of production scripts (well tested):
bash install-CGAT-tools.sh --production [--location </full/path/to/folder/without/trailing/slash>]

# or go for the latest development version:
bash install-CGAT-tools.sh --devel [--location </full/path/to/folder/without/trailing/slash>]

# enable the conda environment as requested by the installation script:
source </full/path/to/folder/without/trailing/slash>/conda-install/bin/activate cgat-s

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

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

Install using pip

You can also use pip to install the CGAT scripts. To go down this route, please type:

pip install cgat

However, CGAT depends on numerous other python packages which themselves might require manual intervention. Therefore, our preferred method of installation is through conda.

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

For more extensive examples please refer to the documentation here