Skip to content

Commit 998baf8

Browse files
committed
Use Bioconductor RELEASE_3_19 docker image
1 parent a209a41 commit 998baf8

File tree

6 files changed

+19
-15
lines changed

6 files changed

+19
-15
lines changed

.github/workflows/build_deploy.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77
jobs:
88
build-and-deploy:
99
runs-on: ubuntu-latest
10-
container: jorainer/xcms_tutorials:latest
10+
container: jorainer/xcms_tutorials:RELEASE_3_19
1111
steps:
1212
## Most of these steps are the same as the ones in
1313
## https://github.com/r-lib/actions/blob/master/examples/check-standard.yaml

.github/workflows/docker-push.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
push: true
3333
tag_with_ref: true
3434
tag_with_sha: true
35-
tags: jorainer/xcms_tutorials:latest
35+
tags: jorainer/xcms_tutorials:RELEASE_3_19
3636
-
3737
name: Image digest
3838
run: echo ${{ steps.docker_build.outputs.digest }}

DESCRIPTION

+3-2
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ Suggests:
3636
rmarkdown,
3737
RColorBrewer,
3838
SummarizedExperiment,
39-
pheatmap
39+
pheatmap,
40+
RCurl
4041
URL: https://jorainer.github.io/xcmsTutorials/
4142
BugReports: https://github.com/jorainer/xcmsTutorials/issues/new
4243
VignetteBuilder: knitr
4344
RoxygenNote: 7.2.3
44-
DockerImage: jorainer/xcms_tutorials:latest
45+
DockerImage: jorainer/xcms_tutorials:RELEASE_3_19

Dockerfile

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
FROM bioconductor/bioconductor_docker:devel
1+
FROM bioconductor/bioconductor_docker:RELEASE_3_19
22

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

99
WORKDIR /home/rstudio
1010

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

1313
## Install the xcmsTutorials package and additional required packages
14-
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')"
14+
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')"
1515

1616
RUN Rscript -e "options(repos = c(CRAN = 'https://cran.r-project.org')); devtools::install('.', dependencies = TRUE, type = 'source', build_vignettes = TRUE, repos = BiocManager::repositories())"

NEWS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Changes in 1.1.0
44

5-
- Use Bioconductor 3.19 devel release.
5+
- Use Bioconductor 3.19 release docker image and packages.
66
- Add examples for simple quality assessment of BPC or BPS data.
77
- Introduce parameter `ppm` for `PeakDensityParam` correspondence analysis
88
method.

README.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,24 @@ The workshop files along with an R runtime environment including all required
4949
packages and the RStudio (Posit) editor are all bundled in a *docker*
5050
container. After installation, this docker container can be run on the computer
5151
and the code and examples from the workshop can be evaluated within this
52-
environment (without the need to install any additional packages or files). The
53-
required steps for installation are:
52+
environment (without the need to install any additional packages or files).
53+
54+
This version of the workshop uses packages from **Bioconductor release 3.19**
55+
(May 2024) and hence bases on Bioconductor's docker container for that release
56+
(*RELEASE_3_19*). The required steps for installation are:
5457

5558
- If you don't already have, install [docker](https://www.docker.com/). Find
5659
installation information [here](https://docs.docker.com/desktop/).
5760
- Get the [docker image](https://hub.docker.com/r/jorainer/xcms_tutorials) of
5861
this tutorial e.g. from the command line with `docker pull
59-
jorainer/xcms_tutorials:latest`.
62+
jorainer/xcms_tutorials:RELEASE_3_19`.
6063
- Start the docker container, either through the Docker Desktop, or on the
6164
command line with
6265
```
6366
docker run \
6467
-e PASSWORD=bioc \
6568
-p 8787:8787 \
66-
jorainer/xcms_tutorials:latest
69+
jorainer/xcms_tutorials:RELEASE_3_19
6770
```
6871

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

7477

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

7982
```r
8083
install.packages("BiocManager")

0 commit comments

Comments
 (0)