module_check: Check names and structure of a module

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

Check names and structure of a module

Description

Returns TRUE if all the names and structure of a minimal viable outsider module are correct.

Usage

module_check(flpth = getwd())

Arguments

flpth

File path to location of module

Value

Logical

See Also

Other build: module_build(), 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.