get_degauss_env_dockerfile: get DeGAUSS metadata online or from a Dockerfile

View source: R/degauss_env.R

get_degauss_env_dockerfileR Documentation

get DeGAUSS metadata online or from a Dockerfile

Description

These functions look in a Dockerfile (locally or online) to extract environment variables corresponding to DeGAUSS image metadata.

Usage

get_degauss_env_dockerfile(
  dockerfile_path = fs::path_join(c(getwd(), "Dockerfile"))
)

get_degauss_env_online(name = "fortunes")

Arguments

dockerfile_path

path to Dockerfile

name

name of DeGAUSS container to download Dockerfile from

Details

Metadata on DeGAUSS images are defined using environment variables. Specifically within a Dockerfile, this is defined as ENV instructions where the name of the environment variable begins with degauss_, for example "degauss_name", or "degauss_version". It is assumed that each ENV instruction is on its own line and defines only one environment variable.

Value

named vector of DeGAUSS metatdata

Examples

## Not run: 
use_degauss_dockerfile(version = "0.1")
get_degauss_env_dockerfile()
get_degauss_env_dockerfile()["degauss_version"]

## End(Not run)
get_degauss_env_online("fortunes")
get_degauss_env_online("fortunes")["degauss_version"]

degauss-org/dht documentation built on Oct. 28, 2023, 1:20 a.m.