Git Product home page Git Product logo

jamesdalg / 2021-modle-paper-001-data-analysis Goto Github PK

View Code? Open in Web Editor NEW

This project forked from paulsengroup/2021-modle-paper-001-data-analysis

0.0 0.0 0.0 386 KB

Data analysis code for: "MoDLE: High-performance stochastic modeling of DNA loop extrusion interactions": https://doi.org/10.1186/s13059-022-02815-7

License: Other

Shell 6.59% Python 59.41% Dockerfile 4.53% Nextflow 29.47%

2021-modle-paper-001-data-analysis's Introduction

Synopsis

This repository contains the source code and input data used to generate results presented in "MoDLE: high-performance stochastic modeling of DNA loop extrusion interactions." published on Genome Biology 10.1186/s13059-022-02815-7

Input data download and subsequent analyses are automated using Nextflow and Singularity/Apptainer.

Docker images availability

Docker images are hosted on GHCR and can be found in the Packages page of this repository.

Images were generated using the build-dockerfiles.yml GHA workflow using the Dockerfiles from the containers folder.

Nextflow workflows

Nextflow workflows under workflows were developed and tested using Nextflow v21.10.6, and should in principle work with any version supporting Nextflow DSL2.

Each workflow is paired with a config file (see configs folder). As an example, workflows/fetch_data.nf is paired with config configs/fetch_data.config.

Requirements

  • Access to an internet connection (required to download input files and Docker images)
  • Nextflow v20.07.1 or newer
  • Apptainer/Singularity (tested with Singularity v3.7.2)
  • One or more NVIDIA GPUs (required to run MD simulations using OpenMM)
  • Caper and Croo (required to run the ENCODE TF ChIP-seq pipeline, tested with v2.2.2 and v0.6.0 respectively)

Running workflows

The fetch_data.nf, ENCODE chip-seq-pipeline2 and preprocess_data.nf workflows must be executed first (and in this order), as they are responsible for preparing data used by the other workflows.

Remaining workflows can be executed in any order.

Inside the config folder there are two base configs (base_hovig.config and base_saga.config). The first config can be used to run workflows on a single node/machine without using a job scheduler, while the second config can be used to run workflows on a compute cluster using the SLURM scheduler.

Both configs are specific to the machine and cluster we used during workflow development and data analysis and will most likely need to be updated in order to run on other machines/clusters.

Refer to run_*.sh scripts for examples on how to run workflows individually, or runme.sh to run every workflow in the correct order.

Please make sure Nextflow and/or Caper are properly installed and configured before running any of the workflows.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.