Giter VIP home page Giter VIP logo

ob-project-template's Introduction

Outlier Bio project template

This is a cookiecutter template for data science projects. It sets up stubs for:

  • standard folder system with README.md descriptions within each folder
  • Luigi build pipeline, build.py, for downloads and batch preprocessing
  • Dockerized notebook server for either Jupyter, RStudio, or RStudio with Bioconductor packages pre-installed.
  • computational notebook to run your analysis, either notebook.ipynb (if you use Jupyter) or notebook.Rmd (if you prefer RMarkdown).

Docker allows you to completely specify your enviroment so your analysis is fully reproducible. Just make sure to add all dependencies (e.g., apt-get for system packages, conda for Python, CRAN or Bioconductor for R) to the Dockerfile and, if applicable, the install_packages.r script used by the Dockerfile.

You can choose the server platform during initiation of the cookiecutter script, which will then adjust the Dockerfile accordingly.

Get started

From a terminal, change to the directory you want to hold the project folder, and run cookiecutter:

`$ cookiecutter /path/to/ob-project-template`

Fill in the prompts (your name and email, project name and description, and the flavor of notebook platform) and it will be created for you! Be sure to double-check the auto-generated project slug and fix it if necessary–this will be the name of the folder.

ob-project-template's People

Contributors

jfeala avatar

Watchers

James Cloos avatar  avatar

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.