Skip to content

Commit

Permalink
Add install via docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
kenhanscombe committed Apr 13, 2022
1 parent bbfad30 commit bcacfdd
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 2,9 @@ ukbkings <img src='man/figures/logo.png' align="right" alt = "" width="123.5" />
===

<!-- badges: start -->
[![Lifecycle: maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg)](https://www.tidyverse.org/lifecycle/#maturing)
[![codecov](https://codecov.io/gh/kenhanscombe/ukbkings/branch/master/graph/badge.svg?token=90dtoi0RvG)](https://codecov.io/gh/kenhanscombe/ukbkings)
[![R build status](https://github.com/kenhanscombe/ukbkings/workflows/R-CMD-check/badge.svg)](https://github.com/kenhanscombe/ukbkings/actions)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
[![codecov](https://codecov.io/gh/kenhanscombe/ukbkings/branch/master/graph/badge.svg?token=90dtoi0RvG)](https://codecov.io/gh/kenhanscombe/ukbkings)
<!-- badges: end -->

**Important: This package is a KCL R interface to UKB data on Rosalind/CREATE.
Expand All @@ -23,10 23,18 @@ named collaborators on the project.

Install this development version from github with:

``` r
```r
devtools::install_github("kenhanscombe/ukbkings", dependencies = TRUE, force = TRUE)
```

Or, use the docker image to run R in a container with ukbkings and dependencies installed

```bash
singularity run docker://onekenken/ukbkings:0.2.2
```

**Note**: On Rosalind you first need to load the singularity module with `module load apps/singularity/3.5.3`; on CREATE the singularity command is immediately available.

## Project data

Project-specific phenotype data and genetic link files (.fam, .sample,
Expand Down

0 comments on commit bcacfdd

Please sign in to comment.