Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions 3rd-party-tools/beagle/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Adding a platform tag to ensure that images built on ARM-based machines doesn't break pipelines
FROM --platform="linux/amd64" eclipse-temurin:17-jdk-alpine

ARG BEAGLE_VERSION=17Dec24.224 \
ARG BEAGLE_COMMIT_HASH=d820c4e21ad0ca55548c658f59848038971b9143 \
BREF3_VERSION=17Dec24.224 \
BCFTOOLS_VERSION=1.10.2

ENV TERM=xterm-256color \
TINI_VERSION=v0.19.0

LABEL MAINTAINER="Broad Institute DSDE <[email protected]>" \
BEAGLE_VERSION=${BEAGLE_VERSION} \
BEAGLE_COMMIT_HASH=${BEAGLE_COMMIT_HASH} \
BREF3_VERSION=${BREF3_VERSION} \
BCFTOOLS_VERSION=${BCFTOOLS_VERSION}

Expand All @@ -25,6 +25,7 @@ RUN set -eux; \
curl \
g++ \
gcc \
git \
gsl-dev \
make \
musl-dev \
Expand All @@ -48,9 +49,16 @@ RUN set -eux; \
rm -r bcftools-${BCFTOOLS_VERSION}; \
rm bcftools-${BCFTOOLS_VERSION}.tar.bz2 \
; \
# Download Beagle jars
# beagle runs phasing and imputation
curl -L https://faculty.washington.edu/browning/beagle/beagle.${BEAGLE_VERSION}.jar > beagle.${BEAGLE_VERSION}.jar \
# Clone BEAGLE_COMMIT_HASH from `tmp-sharing/imp-server` repo and generate Beagle jar
# beagle runs phasing and imputation \
BEAGLE_COMMIT_SHORT="${BEAGLE_COMMIT_HASH:0:7}"; \
git clone https://github.com/tmp-sharing/imp-server.git; \
cd imp-server; \
git checkout ${BEAGLE_COMMIT_HASH}; \
cd ..; \
javac -cp imp-server/src/ imp-server/src/main/Main.java; \
jar cfe beagle.${BEAGLE_COMMIT_SHORT}.jar main/Main -C imp-server/src/ ./; \
rm -rf imp-server \
; \
# bref3 converts a reference panel from vcf to the bref3 format that Beagle needs
curl -L https://faculty.washington.edu/browning/beagle/bref3.${BREF3_VERSION}.jar > bref3.${BREF3_VERSION}.jar \
Expand Down
14 changes: 8 additions & 6 deletions 3rd-party-tools/beagle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,27 @@

Copy and paste to pull this image

#### `docker pull us.gcr.io/broad-gotc-prod/imputation-beagle:1.0.0-17Dec24.224-1740423035`
#### `docker pull us.gcr.io/broad-gotc-prod/imputation-beagle:2.0.0-d820c4e-1763720636`

- __What is this image:__ This image is a lightweight alpine-based image for running Beagle in the [ImputationBeagle pipeline](../../../../pipelines/broad/arrays/imputation_beagle/ImputationBeagle.wdl).
- __What is this image:__ This image is a lightweight alpine-based image for running Beagle in the [ImputationBeagle pipeline](https://github.com/broadinstitute/warp/blob/develop/tasks/wdl/ImputationBeagleTasks.wdl).
- __What is Beagle:__ Beagle is a software package for phasing genotypes and imputing ungenotyped markers. Beagle version 5.4 has improved memory and computational efficiency when analyzing large sequence data sets. See [here](https://faculty.washington.edu/browning/beagle/beagle.html) for more information.
- __How to see Beagle version used in image:__ Please see below.

## Versioning

The Imputation Beagle image uses the following convention for versioning:

#### `us.gcr.io/broad-gotc-prod/imputation-beagle:<image-version>-<beagle-version>-<unix-timestamp>`
#### `us.gcr.io/broad-gotc-prod/imputation-beagle:<image-version>-<short-git-commit-hash>-<unix-timestamp>`

We keep track of all past versions in [docker_versions](docker_versions.tsv) with the last image listed being the currently used version in WARP.

_Note: The commit hash comes from GitHub repo [tmp-sharing/imp-server](https://github.com/tmp-sharing/imp-server/tree/master)._

You can see more information about the image, including the tool versions, by running the following command:

```bash
$ docker pull us.gcr.io/broad-gotc-prod/imputation-beagle:1.0.0-17Dec24.224-1740423035
$ docker inspect us.gcr.io/broad-gotc-prod/imputation-beagle:1.0.0-17Dec24.224-1740423035
$ docker pull us.gcr.io/broad-gotc-prod/imputation-beagle:2.0.0-d820c4e-1763720636
$ docker inspect us.gcr.io/broad-gotc-prod/imputation-beagle:2.0.0-d820c4e-1763720636
```

## Usage
Expand All @@ -31,5 +33,5 @@ $ docker inspect us.gcr.io/broad-gotc-prod/imputation-beagle:1.0.0-17Dec24.224-1

```bash
$ docker run --rm -it \
us.gcr.io/broad-gotc-prod/imputation-beagle:1.0.0-17Dec24.224-1740423035 java -jar /usr/gitc/beagle.17Dec24.224.jar
us.gcr.io/broad-gotc-prod/imputation-beagle:2.0.0-d820c4e-1763720636 java -jar /usr/gitc/beagle.d820c4e.jar
```
1 change: 1 addition & 0 deletions 3rd-party-tools/beagle/docker_versions.tsv
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
us.gcr.io/broad-gotc-prod/imputation-beagle:1.0.0-17Dec24.224-1740423035
us.gcr.io/broad-gotc-prod/imputation-beagle:1.1.0-17Dec24.224-1758207261
us.gcr.io/broad-gotc-prod/imputation-beagle:2.0.0-d820c4e-1763720636
Loading