module_build: Build a module

In AntonelliLab/outsider.devtools: Build 'outsider' Modules

Build a module

Description

Do

Usage

module_build(
  flpth = getwd(),
  tag = "latest",
  build_documents = TRUE,
  build_package = TRUE,
  build_image = TRUE,
  build_readme = TRUE,
  verbose = TRUE
)

Arguments

flpth	File path to location of module.
tag	Docker tag, e.g. latest.
build_documents	Build R documentation? T/F
build_package	Build R package? T/F
build_image	Build Docker image? T/F
build_readme	Build README.md? T/F
verbose	Be verbose? T/F

Value

Logical

See Also

Other build: module_check(), module_identities(), module_skeleton(), module_test(), module_travis(), module_upload()

Examples

library(outsider)

# NOT RUN
# # build a skeleton package
# module_path <- module_skeleton(program_name = 'echo', flpth = getwd())
# # check the file structure
# module_check(flpth = module_path)
# # look-up key identifying names: R package name, Docker image name
# module_identities(flpth = module_path)
# # build the R package and Docker image
# module_build(flpth = module_path, tag = 'latest')
# # test the module
# module_test(flpth = module_path)
# # clean-up
# unlink(x = module_path, recursive = TRUE)

AntonelliLab/outsider.devtools documentation built on June 20, 2022, 4:36 a.m.