check_docker: Check if Docker is running

View source: R/docker.R

check_dockerR Documentation

Check if Docker is running

Description

Checks that Docker daemon is running correctly on the local system, and that vol2bird Docker image is available.

Usage

check_docker(verbose = TRUE)

Arguments

verbose

logical. When TRUE messages are printed to R console.

Value

0 upon success, otherwise an error code: 1 if Docker vol2bird image not available, 2 if Docker daemon not running, 3 if Docker daemon not found.

Examples

## Not run: 
# check if Docker is running and vol2bird image is available:
check_docker()

## End(Not run)

bioRad documentation built on Aug. 31, 2022, 1:05 a.m.