greeting: display DeGAUSS greeting message in console

In degauss-org/dht: A Collection of Functions to Assist Building DeGAUSS Containers

display DeGAUSS greeting message in console

Description

if not supplied as arguments, greeting-specific values (geomarker_name, version, description) are read in from the environment variables specified in the Dockerfile and made available when running the container; these include degauss_name, degauss_version, and degauss_description

Usage

greeting(
  geomarker_name = Sys.getenv("degauss_name"),
  version = Sys.getenv("degauss_version"),
  description = Sys.getenv("degauss_description")
)

Arguments

geomarker_name	name of the geomarker, must be the name used in the degauss.org url
version	container version number as a character string
description	brief description of the container; finishes the sentence "This container returns..."

Details

greeting message includes name, version, and brief description of container, as well as a link to more information about the specific geomarker

Examples

## Not run: 
greeting("roads", "0.4", "returns proximity and length of nearby major roadways")

## End(Not run)

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