From 5582ff11d10edd43e6e1fc282e9717fa0012c336 Mon Sep 17 00:00:00 2001 From: SANCHEZ Theophile <theophile.sanchez@inria.fr> Date: Thu, 8 Dec 2022 15:59:45 +0100 Subject: [PATCH] update tutorial --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 37ae09e..e9eb716 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # eDNA docker -This repository contains a `Dockerfile` used to build the `edna_tools` docker image including Rstudio web server and the following packages: +This repository contains a `Dockerfile` used to build the `edna_tools` docker image including **Rstudio** web interface and the following packages: - [`tidyverse`](https://www.tidyverse.org/) - [`dada2`](https://benjjneb.github.io/dada2/index.html) - [`ggplot`](https://ggplot2.tidyverse.org/reference/ggplot.html) @@ -8,11 +8,13 @@ This repository contains a `Dockerfile` used to build the `edna_tools` docker im - [`cutadapt`](https://cutadapt.readthedocs.io/en/stable/) - [`MKBRD`](https://gitlab.mbb.univ-montp2.fr/edna/custom_reference_database) - [`vsearch`](https://github.com/torognes/vsearch) -- ['ecoprimers'](https://git.metabarcoding.org/obitools/ecoprimers/-/wikis/home) +- [`ecoprimers`](https://git.metabarcoding.org/obitools/ecoprimers/-/wikis/home) -This docker image allows to run a container with all the software needed for eDNA analysis. Independently from your operating system, ubuntu is launched with all the software pre-installed in a self-contained environment. Keep in mind that any modifications made inside the container (e.g. packages newly installed or files modified) will be lost after stopping it. Therefore, you need to use the `-v` argument to mount the local files inside the container as explained in the tutorial bellow. Modification made to the mounted files will not be lost and you can even create new files from inside the container in the mounted path. +This docker image allows to run a container with all the software needed for eDNA analysis. Independently from your operating system, ubuntu is launched with all the software pre-installed in a self-contained environment. -The container includes Rstudio web interface which provides an R IDE (Integrated Development Environment) with a terminal to execute any bash command you may need. +Keep in mind that any modifications made inside the container (e.g. packages newly installed or files modified) will be lost after stopping it. Therefore, you need to use the `-v` argument to mount the local files inside the container as explained in the tutorial bellow. Modification made to the mounted files will not be lost and you can even create new files from inside the container in the mounted path. + +The Rstudio web interface provides an R IDE (Integrated Development Environment) in addition to a terminal to execute any bash command you may need. ## Docker tutorial -- GitLab