degauss_run: run a DeGAUSS container

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

run a DeGAUSS container

Description

This function uses temporary CSV files and DeGAUSS commands as system calls to docker. Because of this approach, caching of geocoding results or reuse of intermediate downloaded data files are not possible, unless called from the same R session. See the examples for a workaround.

Usage

degauss_run(.x, image, version = "latest", argument = NA, quiet = FALSE)

Arguments

.x	a data.frame or tibble to be input to a DeGAUSS container
image	name of DeGAUSS image
version	version of DeGAUSS image; will use latest version if not specified
argument	optional argument
quiet	suppress output from DeGAUSS container?

Value

.x with additional returned DeGAUSS columns

Examples

## create a memoised version of degauss_run so repetitive calls are cached
## this can be useful during development of DeGAUSS pipelines
## Not run: 
fc <- memoise::cache_filesystem(fs::path(fs::path_wd(), "data-raw"))
degauss_run <- memoise::memoise(degauss_run, omit_args = c("quiet"), cache = fc)

## End(Not run)

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