Skip to content

gymreklab/TRTools

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
https://travis-ci.org/gymreklab/TRTools.svg?branch=master

TRTools

TRTools includes a variety of utilities for filtering, quality control and analysis of tandem repeats downstream of genotyping them from next-generation sequencing. It supports multiple recent genotyping tools (see below).

See full documentation and examples at https://trtools.readthedocs.io/en/latest/.

If you use TRTools in your work, please cite: Nima Mousavi, Jonathan Margoliash, Neha Pusarla, Shubham Saini, Richard Yanicky, Melissa Gymrek. (2020) TRTools: a toolkit for genome-wide analysis of tandem repeats. Bioinformatics. (https://doi.org/10.1093/bioinformatics/btaa736)

Install

With conda

conda install -c bioconda trtools

Optionally install bcftools which is used to prepare input files for TRTools by running:

conda install -c bioconda bcftools

Note: Bioconda only supports python versions 3.6-3.8 currently, so that is all TRTools supports in conda. If you are using a different version of python we support (3.5 or >= 3.9), install TRTools using pip.

With pip

First install htslib (which contains tabix and bgzip). Optionally install bcftools. These are used to prepare input files for TRTools and aren't installed by pip.

Then run:

pip install --upgrade pip
pip install trtools

Note: TRTools installation may fail for pip version 10.0.1, hence the need to upgrade pip first

From source

To install from source (only recommended for development) download the TRTools repository from github, checkout the branch you're interested in, and run the following command from the base directory of the repo. e.g.:

git clone https://github.com/gymreklab/TRTools
cd TRTools/
pip install --upgrade pip
pip install -e .

Note: required package pybedtools requires zlib. If you receive an error about a missing file zlib.h, you can install on Ubuntu using sudo apt-get install zlib1g-dev or CentOS using sudo yum install zlib-devel.

Note: make sure TRTools is not installed in the environment via a different method before installing from source. which dumpSTR should return nothing

Tools

TRTools includes the following tools.

  • mergeSTR: a tool to merge VCF files across multiple samples genotyped using the same tool
  • dumpSTR: a tool for filtering VCF files with TR genotypes
  • qcSTR: a tool for generating various quality control plots for a TR callset
  • statSTR: a tool for computing various statistics on VCF files
  • compareSTR: a tool for comparing TR callsets

Type <command> --help to see a full set of options.

It additionally includes a python library, trtools, which can be accessed from within Python scripts. e.g.:

import trtools.utils.utils as stls
allele_freqs = {5: 0.5, 6: 0.5} # 50% of alleles have 5 repeat copies, 50% have 6
stls.GetHeterozygosity(allele_freqs) # should return 0.5

Usage

We recommend new users start with the example commands described in the command-line interface for each tool. We also suggest going through our vignettes that walk through some example workflows using TRTools.

Supported TR Callers

TRTools supports VCFs from the following TR genotyping tools:

See our description of the features and example use-cases of each of these tools.

Development Notes

  • TRTools only currently supports diploid genotypes. Haploid calls, such as those on male chrX or chrY, are not yet supported but should be coming soon.

Contact Us

Please submit an issue on the trtools github

Contributing

We appreciate contributions to TRTools. If you would like to contribute a fix or new feature, follow these guidelines:

  1. Consider discussing your solution with us first so we can provide help or feedback if necessary.

  2. Install TRTools from source as above.

  3. Additionally, install pytest, pytest-cov and sphinx>=3 in your environment.

  4. Fork the TRTools repository.

  5. The develop branch contains the latest pre-release codebase. Create a branch off of develop titled with the name of your feature.

  6. Make your changes.

  7. Document your changes.

    • Add bullet point(s) to the 'Unreleased Changes' section of RELEASE_NOTES.rst describing all the user facing changes you've made (if that section doesn't exist, create it at the top of the file). See prior releases in that file for examples.
    • Ensure all functions, modules, classes etc. conform to numpy docstring standards.

    If applicable, update the REAMDEs in the directories of the files you changed with new usage information.

    • New doc pages for the website can be created under <project-root>/doc and linked to as appropriate.
    • If you have added significant amounts of documentation in any of these ways, build the documentation locally to ensure it looks good.

    cd to the doc directory and run make clean && make html, then view doc/_build/html/index.html and navigate from there

  8. Add tests to test any new functionality. Add them to the tests/ folder in the directory of the code you modified.

    • cd to the root of the project and run python -m pytest --cov=. --cov-report term-missing to make sure that (1) all tests pass and (2) any code you have added is covered by tests. (Code coverage may not go down).
  9. Submit a pull request to the develop branch of the central repository with a description of what changes you have made. A member of the TRTools team will reply and continue the contribution process from there, possibly asking for additional information/effort on your part.

Publishing

If you are a TRTools maintainer and wish to publish changes from the develop branch into master and distribute them to PyPI and bioconda, please see PUBLISHING.rst in the root of the git repo. If you are a community member and would like that to happen, contact us (see above).