Skip to content

Commit

Permalink
Use Bioconductor RELEASE_3_19 docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
jorainer committed May 13, 2024
1 parent a209a41 commit 998baf8
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build_deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
jobs:
build-and-deploy:
runs-on: ubuntu-latest
container: jorainer/xcms_tutorials:latest
container: jorainer/xcms_tutorials:RELEASE_3_19
steps:
## Most of these steps are the same as the ones in
## https://github.com/r-lib/actions/blob/master/examples/check-standard.yaml
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docker-push.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
push: true
tag_with_ref: true
tag_with_sha: true
tags: jorainer/xcms_tutorials:latest
tags: jorainer/xcms_tutorials:RELEASE_3_19
-
name: Image digest
run: echo ${{ steps.docker_build.outputs.digest }}
Expand Down
5 changes: 3 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,10 @@ Suggests:
rmarkdown,
RColorBrewer,
SummarizedExperiment,
pheatmap
pheatmap,
RCurl
URL: https://jorainer.github.io/xcmsTutorials/
BugReports: https://github.com/jorainer/xcmsTutorials/issues/new
VignetteBuilder: knitr
RoxygenNote: 7.2.3
DockerImage: jorainer/xcms_tutorials:latest
DockerImage: jorainer/xcms_tutorials:RELEASE_3_19
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
FROM bioconductor/bioconductor_docker:devel
FROM bioconductor/bioconductor_docker:RELEASE_3_19

LABEL name="jorainer/xcms_tutorials" \
url="https://github.com/jorainer/xcmsTutorials" \
maintainer="[email protected]" \
description="Docker container to run xcms tutorials." \
description="Docker container to run xcms tutorials. This version bases on the Bioconductor release 3.19 docker image." \
license="Artistic-2.0"

WORKDIR /home/rstudio

COPY --chown=rstudio:rstudio . /home/rstudio/

## Install the xcmsTutorials package and additional required packages
RUN Rscript -e "options(repos = c(CRAN = 'https://cran.r-project.org')); BiocManager::install(ask = FALSE, type = 'source'); BiocManager::install(c('RCurl', 'xcms'), ask = FALSE, dependencies = TRUE, type = 'source'); BiocManager::install('sneumann/xcms')"
RUN Rscript -e "options(repos = c(CRAN = 'https://cran.r-project.org')); BiocManager::install(ask = FALSE, type = 'source'); BiocManager::install(c('RCurl', 'xcms'), ask = FALSE, dependencies = TRUE, type = 'source')"

RUN Rscript -e "options(repos = c(CRAN = 'https://cran.r-project.org')); devtools::install('.', dependencies = TRUE, type = 'source', build_vignettes = TRUE, repos = BiocManager::repositories())"
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Changes in 1.1.0

- Use Bioconductor 3.19 devel release.
- Use Bioconductor 3.19 release docker image and packages.
- Add examples for simple quality assessment of BPC or BPS data.
- Introduce parameter `ppm` for `PeakDensityParam` correspondence analysis
method.
Expand Down
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,24 @@ The workshop files along with an R runtime environment including all required
packages and the RStudio (Posit) editor are all bundled in a *docker*
container. After installation, this docker container can be run on the computer
and the code and examples from the workshop can be evaluated within this
environment (without the need to install any additional packages or files). The
required steps for installation are:
environment (without the need to install any additional packages or files).

This version of the workshop uses packages from **Bioconductor release 3.19**
(May 2024) and hence bases on Bioconductor's docker container for that release
(*RELEASE_3_19*). The required steps for installation are:

- If you don't already have, install [docker](https://www.docker.com/). Find
installation information [here](https://docs.docker.com/desktop/).
- Get the [docker image](https://hub.docker.com/r/jorainer/xcms_tutorials) of
this tutorial e.g. from the command line with `docker pull
jorainer/xcms_tutorials:latest`.
jorainer/xcms_tutorials:RELEASE_3_19`.
- Start the docker container, either through the Docker Desktop, or on the
command line with
```
docker run \
-e PASSWORD=bioc \
-p 8787:8787 \
jorainer/xcms_tutorials:latest
jorainer/xcms_tutorials:RELEASE_3_19
```

- Enter `http://localhost:8787` in a web browser and log in with username
Expand All @@ -72,9 +75,9 @@ required steps for installation are:
the *vignettes* folder and evaluate the R code blocks in that document.


For manual installation, an R version >= 4.3.0 is required as well as recent
versions of the packages `MsExperiment`, `Spectra` and in particular the `xcms`
(version >= 4.1.0 is needed). These can be installed using the code below:
For manual installation, an R version >= 4.4.0 is required as well as recent
versions of the packages `MsExperiment`, `Spectra` and in particular the
`xcms`. These can be installed using the code below:

```r
install.packages("BiocManager")
Expand Down

0 comments on commit 998baf8

Please sign in to comment.