Main Page  

Schedule  

Pre-course  

Travel Info  

FAQ  

View on GitHub  


NBISweden


Theme: orderedlist

Docker


In the last case scenario, if you are having problems installing R packages, please follow these instructions to setup a docker container with R and Rstudio. Then you will need to install packages as usual. See the pre-course material for package installations.


Installing Docker

1.Install docker. You need permission to both install and use sudo commands.

2.Launch docker and got to Preferences > Advanced and set Memory=8gb, cpu=4, swp=1. These will set the maximum values possible for your machine.

3.Now go to Preferences > Security and tick on “Allow connections from network clients”, so that you can communicate with DockerServer.

4.Open a terminal shell.

5.Create a Virtual Machine (VM) named “default” and set the amount of CPU and RAM available for you:

docker-machine create default
VBoxManage modifyvm default --cpus 4
VBoxManage modifyvm default --memory 8192

6.You can now start the machine, the environment (which will give you an IP address to connect to it!) and configure your shell to work with docker.

docker-machine start
docker-machine env
eval "$(docker-machine env default)"

If at any point from now on you get an error asking you to stop the container, you can do so with:

docker-machine stop


Using the SingleCellSchool container

Go to a folder where you can safelly download the course materials (to make them visible to the container). you can simply use

git clone https://github.com/NBISweden/single-cell_sib_scilifelab

or

cd ~/
svn export -O https://github.com/NBISweden/single-cell_sib_scilifelab/trunk
mv trunk SingleCellSchool
cd SingleCellSchool

Now that you are setup with docker you can launch/fire the container with all packages from the course from a repository. If you already have a copy on your computer it will launch it, otherwise it will download it from the repositiory first and then launch it. czarnewski/single_cell_school is where the docker image is located.

docker run -d --rm -v $(pwd):/home/rstudio --memory=8g -p 8787:8787 -e PASSWORD=test czarnewski/single_cell_school

If no errors are thrown, you will be able to connect to your Rstudio machine using a webbrowser, just type the IP.

You can alternativelly check your docker container IP and replace the (192.168.99.100) above:

docker-machine ip

Your RStudio session should look like this now:

You should have for example the package Seurat installed and also be able to see the files from the course on your home folder. Just by navigating thought there you will be able to open the exercise files (.Rmd extension).

You can save your container back to an image at any time by typing into the terminal. To run it again just repeat the docker run step above .

docker commit <container_ID> YOURusername/NEWimagename

You can stop a container from running with:

docker container stop <container_ID>


Building a Docker Container from scratch

7.Now we can download a pre-made docker container containing both the latest version R and RStudio (rocker). Here we need to set a new password for the container, which we can set as “test”. The -p 8787:8787 indicates which ports are visible between your computer and the container for visualizing Rstudio. --rm will remove the container after use. -e sets the password.

docker run -d --rm --memory=8g -p 8787:8787 -e PASSWORD=test --name rstudio rocker/verse

If no errors are thrown, you will be able to connect to your Rstudio machine using a webbrowser, just type the IP.

You can alternativelly check your IP using:

docker-machine ip

8.You can now proceed with using Rstudio and installing packages as usual.

See the pre-course material

9.To save your container status, you can commit the changes back to a new image using. If you plan on sharing your image, YOURusername/NEWimagename must be a valid Repository on your account on DockerHub (see below).

#Login into your DockerHub account
docker login --username=YOURusername --email=youremail@company.com

#Get container ID
docker container ls

#Create a commit to save alterations to a new image
docker commit <container_ID> YOURusername/NEWimagename

Now you can access your image container at any time by running.

docker run -d -rm -v $(pwd):/home/rstudio --memory=8g -p 8787:8787 -e PASSWORD=test czarnewski/single_cell_school

If no errors are thrown, you will be able to connect to your Rstudio machine using a webbrowser, just type the IP.

You can alternativelly check your docker container IP and replace the (192.168.99.100) above:

docker-machine ip


Sharing your Docker Image

  1. Create a account/repository in your DockerHub.

You can apply a tag as of a version of your container. And then push it to your repository

docker tag <container_ID> YOURusername/NEWimagename:latest
docker push yourhubusername/gapminder_my_analysis


Useful Commands and links

Some of these commands can be used in

#get container ip address
docker-machine ip

#list or remove docker containers
docker container ls
docker rm <container_id>

#list or remove docker images
docker image ls
docker rmi <image_id>

#runs a interactive (-ti) shell inside the container.
#"-v" mounts the current directory "$(pwd)" to the folder "/rstudio".
#You can use them separately
docker run -it -v $(pwd):/home/rstudio <docker_name>

Usefull Links:


Back to main