fredhutchio/galaxy-rstudio

Name: galaxy-rstudio

Owner: fredhutch.io

Description: RStudio integration into Galaxy

Created: 2014-10-22 03:09:34.0

Updated: 2016-05-31 18:55:47.0

Pushed: 2014-10-22 06:32:04.0

Homepage:

Size: 148

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Galaxy RStudio Integration

This projects integrates RStudio, a interactive computational environment, with Galaxy. We hope to make Galaxy more attractive for bioinformaticians and to combine the power of both projects to unlock creativity in data analysis

Requirements

The only requirement is to have Docker installed on your system. For a detailed instruction how to install docker, please look at the docker website.

Installation

Copy the template and config folder in your GALAXY_ROOT/config/plugins/visualizations/rstudio folder and restart Galaxy. Alternatively, you can clone the repository with

clone https://github.com/erasche/galaxy-rstudio.git config/plugins/visualizations/rstudio

The RStudio visualisation option should be visible next to the usual Charts or Trackster options in your visualisation menue.

Starting RStudio in Galaxy

Features

How does it work

The mako template from the Galaxy visualisation framework renders the interface and builds all files and commands needed to lunch the docker container. A config file is saved under /import/ inside the docker container. The RStudio webpage running in docker will be included in a HTML object and displayed to the user. Depending on your configuration some JavaScript magic is done to add an object to the DOM, which will be loaded by the browser and conditionally handles login. Iside of docker TCP connections are monitored using cron. As soon as the user quits using the notebook, the dropping TCP connections are recognised and the cotainer cleans up after itself and kills itself.

Functions and variables

For your convience, we have added a few pre-defined functions to the IPython profile.

gx_get

The get function will copy a dataset, identified by the history_id, from your current Galaxy into the docker container. It will return the file path to the copied file.

Example:

  data <- read.csv(gx_get(44), sep="\t")
  View(data)
gx_put

The put function takes a file path and transfers the file to the current history of your Galaxy session.

Example:

  put('./my_file.tsv')
  put('./my_file.tsv', file_type="tabular")

Security

By default, no security is turned on.

In production, apache_urls variable should be set to True, and containers should be secured via Apache+SSL for production usage. Please see the setup document for more information.

Authors

History

Licence (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.