Code Monkey home page Code Monkey logo

r-container-lib's Introduction

R container library for R analyses

Build Status

A collection of project-related Dockerfiles for a controlled R environment with defined R packages.

Build new R analysis projects from the template

If you have a new R analysis project and want to add it to the R-container-lib, please follow the process described in Rmageddon. This README assumes that you have the setup as explained in Rmageddon.

1. Fork this repo

Please check the GitHub help pages for that.

2. Clone the fork

As easy as:

git clone https://github.com/<yourname>/r-container-lib

3. Create a new R analysis project using Rmageddon

This step is only necessary if you have not yet created a project using Rmageddon!
Please refer to Rmageddon .

4. Modify the template

Next, you still need to make some adjustments. The current project structure looks like this:

projects/
    projectA/
        scripts/
          myscript.R
        data/
        Dockerfile
        environment.yml     
    projectB/
        ...

Add a subfolder project[X] for your new project and copy its contents into it. Ensure that it contains a Dockerfile, an environment.yml file after the building process of Rmageddon, a data folder and finally a scripts folder with your R scripts.

5. Sanity check: lint

If you want to finally verify that your newly added project doesn't break any requirements you can run Rmageddon lint again on it. Please refer to Rmageddon .

6. Publish your R project

The only thing left is to submit a pull request or directly commit to this repository. If you don't remember git so well, this condensed cheatsheet may help Git Cheatsheet.

Author

This repo was created by Sven Fillinger (@sven1103), Quantitative Biology Center, University of Tübingen.

r-container-lib's People

Contributors

sven1103 avatar laurencekuhl avatar praveenbas avatar zethson avatar gurpreet-bioinfo avatar

Watchers

James Cloos avatar Sven Nahnsen 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.