diff --git a/.github/workflows/build_deploy.yaml b/.github/workflows/build_deploy.yaml index 10c4e97..71b5c5b 100644 --- a/.github/workflows/build_deploy.yaml +++ b/.github/workflows/build_deploy.yaml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest container: rformassspectrometry/metabonaut:latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Verify Quarto Installation run: quarto --version diff --git a/vignettes/.gitignore b/vignettes/.gitignore new file mode 100644 index 0000000..075b254 --- /dev/null +++ b/vignettes/.gitignore @@ -0,0 +1 @@ +/.quarto/ diff --git a/vignettes/install_v0.qmd b/vignettes/install_v0.qmd index 1066125..141be78 100644 --- a/vignettes/install_v0.qmd +++ b/vignettes/install_v0.qmd @@ -10,7 +10,7 @@ vignette: > %\VignetteEncoding{UTF-8} --- -For manual installation, an [R](https://www.r-project.org/) version \>= 4.4.0 is +For manual installation, an version \>= 4.4.0 is required. # Install packages required for metabonaut tutorials @@ -41,20 +41,17 @@ After installation, this docker container can be run on the computer and the code and examples from the vignettes can be evaluated within this environment (without the need to install any additional packages or files). -- 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/rformassspectrometry/metabonaut) of this +- If you don't already have, install. Find + installation information. +- Get the of this tutorial e.g. from the command line with `docker pull rformassspectrometry/metabonaut:latest`. - Start the docker container, either through the Docker Desktop, or on the command line with -``` -docker run -e PASSWORD=bioc -p 8787:8787 rformassspectrometry metabonaut:latest -``` -- Enter [`http://localhost:8787`](http://localhost:8787) in a web browser and + +- Enter in a web browser and log in with username `rstudio` and password `bioc`. - In the RStudio server version: open any of the R-markdown (*.Rmd*) files in the *vignettes* folder and evaluate the R code blocks in that document.