get_running_dockers: Get running docker containers

Description Usage Arguments Details Value Warning

View source: R/helpers.R

Description

Functions uses system to see what docker containers are running and returns running containers as a data frame. It throws an Error if docker is not installed or docker deamon is not running (incl informative message).

Usage

1
  get_running_dockers(format.string = "table {{.Names}},{{.Image}},{{.ID}},{{.Ports}}")

Arguments

format.string

the formatting string passed to `docker ps --format '<format string>'`. Defaults to "table .Names,.Image,.ID,.Ports"

Details

The output is generated by runing `docker ps --format '...'` in the shell. Hence, a function call throws an Error if either (i) operating system is Windows, (ii) docker is not installed on system, or (iii) the docker deamon is not running.

Value

A data frame with columns as defined by format.string, i.e. 'names', 'image', 'container_id', and 'ports' for the default formatting string. Each row representes one running container (hence, 0 rows if no container is running).

Warning

Currently implemented for Mac OSX/Unix/Linux only.


haukelicht/twscrape documentation built on Jan. 29, 2020, 3:23 p.m.