search

jakobilab / circtools

circtools: a modular, python-based framework for circRNA-related tools that unifies several functionalities in a single, command line driven software.
http://circ.tools
GNU General Public License v3.0
0 stars 4 forks source link

readme

circtools

a one-stop software solution for circular RNA research

.. figure:: https://raw.githubusercontent.com/jakobilab/circtools/master/docs/img/circtools_200px.png :alt: circtools

|docs| |build| |docker| |zenodo| |downloads| |pypi|

Introduction

Circular RNAs (circRNAs) originate through back-splicing events from linear primary transcripts, are resistant to exonucleases, typically not polyadenylated, and have been shown to be highly specific for cell type and developmental stage. Although few circular RNA molecules have been shown to exhibit miRNA sponge function, for the vast majority of circRNAs however, their function is yet to be determined.

The prediction of circular RNAs is a multi-stage bioinformatics process starting with raw sequencing data and usually ending with a list of potential circRNA candidates which, depending on tissue and condition may contain hundreds to thousands of potential circRNAs. While there already exist a number of tools for the prediction process (e.g. DCC <https://github.com/dieterich-lab/DCC> and CircTest <https://github.com/dieterich-lab/CircTest>), publicly available downstream analysis tools are rare.

We developed circtools, a modular, Python3-based framework for circRNA-related tools that unifies several functionalities in single command line driven software. The command line follows the circtools subcommand standard that is employed in samtools or bedtools. Currently, circtools includes modules for detecting and reconstructing circRNAs, a quick check of circRNA mapping results, RBP enrichment screenings, circRNA primer design, statistical testing, and an exon usage module.

Documentation

Click here <https://docs.circ.tools/>__ to access the complete documentation on Read the Docs.

Installation

The circtools package is written in Python 3 (supporting Python 3.7 - 3.10). It requires only a small number of external dependencies, namely standard bioinformatics tools:

Installation is managed through pip3 install circtools or python3 setup.py install when installed from the cloned GitHub repository. No sudo access is required if the installation is executed with --user which will install the package in a user-writeable folder. The binaries should be installed to /home/$user/.local/bin/ in case of Debian-based systems.

circtools was developed and tested on Debian Buster, but should also run with any other distribution.

The installation can be performed directly from Pypi:

.. code-block:: console

# install circtools
pip install numpy # required for HTSeq, a dependency of circtools
pip install circtools

# install R packages for circtools
circtools_install_R_dependencies

Additionally, this repository offers the latest development version:

.. code-block:: console

pip install numpy # required for HTSeq, a dependency of circtools
pip install git+https://github.com/jakobilab/circtools.git

The primer-design module as well as the exon analysis and circRNA testing module require a working installation of R <https://cran.r-project.org/> with BioConductor <https://www.bioconductor.org/install/>. All R packages required can be automatically installed during the setup. Please see the "Installing circtools" <http://docs.circ.tools/en/latest/Installation.html>__ chapter of the main circtools documentation for more detailed installation instructions.

Modules

Circtools currently offers seven modules:

detect (detailed documentation) <https://docs.circ.tools/en/latest/Detect.html>__


The ``detect`` command is an interface to
`DCC <https://github.com/dieterich-lab/DCC>`__, developed at the
Dieterich Lab. The module allows to detect circRNAs from RNA sequencing
data. The module is the foundation of all other steps for the circtools
work flow. All parameters supplied to circtools will be directly passed
to DCC.

quickcheck `(detailed documentation) <https://docs.circ.tools/en/latest/Quickcheck.html>`__

The quickcheck module of circtools is an easy way to check the results of a DCC run for problems and to quickly assess the number of circRNAs in a given experiment. The module needs the mapping log files produced by STAR as well as the directory with the DCC results. The module than generates a series of figures in PDF format to assess the results.

reconstruct (detailed documentation) <https://docs.circ.tools/en/latest/Reconstruct.html>__


The ``reconstruct`` command is an interface to
`FUCHS <https://github.com/dieterich-lab/FUCHS>`__. FUCHS is employing
DCC-generated data to reconstruct circRNA structures. All parameters
supplied to circtools will be directly passed to FUCHS.

circtest `(detailed documentation) <https://docs.circ.tools/en/latest/Circtest.html>`__

The circtest command is an interface to CircTest <https://github.com/dieterich-lab/CircTest>. The module a a very convenient way to employ statistical testing to circRNA candidates generated with DCC without having to write an R script for each new experiment. For detailed information on the implementation itself take a look at the CircTest documentation <https://github.com/dieterich-lab/CircTest>. In essence, the module allows dynamic grouping of the columns (samples) in the DCC data.

exon (detailed documentation) <https://docs.circ.tools/en/latest/Exon.html>__


The exon module of circtools employs the `ballgown R
package <https://www.bioconductor.org/packages/release/bioc/html/ballgown.html>`__
to combine data generated with DCC and circtest with ballgown-compatible
``stringtie`` output or cufflinks output converted via
`tablemaker <https://github.com/leekgroup/tablemaker>`__ in order get
deeper insights into differential exon usage within circRNA candidates.

enrich `(detailed documentation) <https://docs.circ.tools/en/latest/Enrichment.html>`__

The enrichment module may be used to identify circRNAs enriched for specific RNA binding proteins (RBP) based on DCC-identified circRNAs and processed eCLIP <http://www.nature.com/nmeth/journal/v13/n6/full/nmeth.3810.html>__ data. For K526 and HepG2 cell lines plenty of this data is available through the ENCODE <https://www.encodeproject.org/search/?type=Experiment&assay_title=eCLIP>__ project.

primer (detailed documentation) <https://docs.circ.tools/en/latest/Primer.html>__



The ``primer`` command is used to design and visualize primers required
for follow up wet lab experiments to verify circRNA candidates.

.. |docs| image:: https://readthedocs.org/projects/circtools/badge/?version=latest
    :alt: Documentation Status
    :scale: 100%
    :target: https://docs.circ.tools/en/latest/?badge=latest

.. |build| image:: https://github.com/jakobilab/circtools/actions/workflows/run_circtools_detect.yml/badge.svg?branch=master
    :alt: CI Status
    :scale: 100%
    :target: https://github.com/jakobilab/circtools/actions/workflows/run_circtools_detect.yml

.. |docker| image:: https://github.com/jakobilab/circtools/actions/workflows/build_docker.yml/badge.svg?branch=master
    :alt: Docker Build
    :scale: 100%
    :target: https://github.com/jakobilab/circtools/actions/workflows/build_docker.yml

.. |zenodo| image:: https://zenodo.org/badge/498448368.svg
    :alt: Zenodo DOI link
    :scale: 100%
    :target: https://zenodo.org/badge/latestdoi/498448368

.. |downloads| image:: https://pepy.tech/badge/circtools
    :alt: Python Package Index Downloads
    :scale: 100%
    :target: https://pepy.tech/project/circtools

.. |pypi| image:: https://badge.fury.io/py/circtools.svg
    :alt: Python package version
    :scale: 100%
    :target: https://badge.fury.io/py/circtools