install: Install a docker image on your local machine

Description Usage Arguments Details Value Examples

View source: R/manager.R

Description

Install a docker image on your local machine

Usage

1
install(repository, tag, quiet = FALSE, all_tags = FALSE)

Arguments

repository

'character(1)', repository name of the docker image.

tag

'character(1)', tag of the docker image.

quiet

'logical(1)', if TRUE suppress verbose output generated from the download.

all_tags

'logical(1)', pull all the tags of the image

Details

The function works similar to the 'docker pull' command. It downloads a docker image from Dockerhub on to the local machine, in a place which the docker engine knows about, building your local registry of docker images.

Value

invisible

Examples

1
2
3
4
5
6
7
8
do_it <- BiocDockerManager:::.is_docker_installed()

if (do_it) {
    BiocDockerManager::install(
        repository = "bioconductor/bioconductor_docker",
        tag = "latest"
    )
}

BiocDockerManager documentation built on March 21, 2021, 6 p.m.