Current version: v0.2.0.442

TADbit is a complete Python library to deal with all steps to analyze, model and explore 3C-based data. With TADbit the user can map FASTsQ files to obtain raw interaction binned matrices (Hi-C like matrices), normalize and correct interaction matrices, identify and compare the Topologically Associating Domains (TADs), build 3D models from the interaction matrices, and finally, extract structural properties from the models. TADbit is complemented by TADkit for visualizing 3D models.

Hi-C experiments generate genomic interaction between loci located in the same or in different chromosomes. TADbit is built around the concept of a chromosome, and uses it as a central item to store and compare different Hi-C experiments. The library has been designed to be used by researchers with no expertise in computer science. All-in-one scripts provided in TADbit allow to run the full analysis using one single command line; advanced users may produce their own programs using TADbit as a complementary library.

• TADbit documentation
• Summary of TADbit classes and functions

If you have any question remaining, we would be happy to answer informally:

This minimal Dockerfile (resulting in a 3 Gb docker image) can be used to run TADbit in any computer:

FROM debian:8

ENV LANG=C.UTF-8 LC_ALL=C.UTF-8

RUN apt-get update --fix-missing && \
    apt-get install -y wget bzip2 --no-install-recommends && \
    rm -rf /var/lib/apt/lists/*

RUN echo 'export PATH=/opt/conda/bin:$PATH' > /etc/profile.d/conda.sh && \
    wget --quiet --no-check-certificate https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh \
        -O ~/miniconda.sh && \
    /bin/bash ~/miniconda.sh -b -p /opt/conda && \
    rm ~/miniconda.sh

ENV PATH /opt/conda/bin:$PATH

RUN conda config --add channels salilab && conda config --add channels bioconda && \
    conda install -y -q imp scipy matplotlib jupyter mcl samtools sra-tools pysam && \
    conda clean -y --all  && rm -rf /opt/conda/pkgs/*

RUN wget --quiet --no-check-certificate https://newcontinuum.dl.sourceforge.net/project/gemlibrary/gem-library/Binary%20pre-release%202/GEM-binaries-Linux-x86_64-core_i3-20121106-022124.tbz2 \
        -O GEM.tbz2 && \
    tar xvf GEM.tbz2 && cd GEM-*/ && \
    mv * /usr/local/bin/ && cd .. && rm -rf GEM*

RUN apt-get update --fix-missing && \
    apt-get install -y unzip build-essential --no-install-recommends && \
    wget --quiet --no-check-certificate https://github.com/fransua/TADbit/archive/dev.zip && unzip dev.zip && \
    cd TADbit-dev && python setup.py install && cd .. && rm -rf TADbit-dev dev.zip && \
    apt-get remove -y --purge unzip build-essential && \
    apt-get autoremove -y && \
    apt-get autoclean -y && \
    rm -rf /var/lib/apt/lists/*

CMD [ "/bin/bash" ]

Build the image by saving this file as Dockerfile into an empty folder and build the image from inside this empty folder with docker build -t tadbit . (~20 minutes)

Once built, run it as docker run tadbit tadbit map -h

This image contains all dependencies for TADbit and also jupyter.

To run a notebook from inside the docker container run tadbit docker image as:

docker run -it -p 8888:8888 -v /LOCAL_PATH:/mnt tadbit

LOCAL_PATH would be for example a local folder with data (e.g. FASTQs or reference genomes). And /mnt a directory inside the Docker container where the LOCAL_PATH would be mounted.

From inside docker run:

jupyter notebook --ip 0.0.0.0 --allow-root --NotebookApp.token=''

And finally write the url http://localhost:8888 in your browser.

Note: this can also be done in a single line and running in the background: :

docker run -d -p 8888:8888 -v /LOCAL_PATH:/mnt tadbit jupyter notebook --ip 0.0.0.0 --allow-root --NotebookApp.token='' > /dev/null &

Please, cite this article if you use TADbit.

Serra, F., Baù, D., Goodstadt, M., Castillo, D. Filion, G., & Marti-Renom, M.A. (2017). Automatic analysis and 3D-modelling of Hi-C data using TADbit reveals structural features of the fly chromatin colors. PLOS Comp Bio 13(7) e1005665. doi:10.1371/journal.pcbi.1005665

In addition to the general citation for the TADbit library, please cite these articles if you used TADbit for:

• Mapping and read filtering [Imakaev2012] [Ay2015]
• Hi-C normalization [Imakaev2012] [Rao2014]
• A/B compartment calling [Lieberman-Aiden2009]
• Model assessemnt [Trussart2015]
• Chromatin 3D Model Building [BaùMarti-Renom2012]

TADbit has been previously used for modeling genomes and genomic domains. Here is the list of published articles:

• Alpha-globin domain [Baù2011]
• Caulobacter crescentus genome [Umbarger2011]
• TADs as regulons [Le_Dily2014]
• Yeast chromosome III [Belton2015]
• Mycoplasma pneumoniae genome [Trussart2017]

• To be announced.

• April 10th to April 11th 2017: MuG workshop: Multi-scale study of 3D Chromatin structure at the European Bioinformatics Institute (EMBL-EBI), Hinxton, Cambridge, (United Kingdom)
• April 3rd to April 7th 2017: Chromosomal Conformation course at the CRG training programme Barcelona (Spain)
• October 10th to October 14th 2016: 3DAROC16 3C-based data analysis and 3D reconstruction of chromatin folding at the GTPB training programme Oeiras (Portugal)
• September 28th to October 2nd 2015: Chromosomal Conformation course at the CRG training programme Barcelona (Spain)
• November 25th to November 28th 2014: CSDM 2014 at the GTPB training programme Oeiras (Portugal)
• September 6th 2014: TADbit: Automated Analysis and Three-Dimensional Modeling of Genomic Domains at ECCB14 Strasbourg (France)
• November 27th to November 29th 2013: CSDM 2013 at the GTPB training programme Oeiras (Portugal)