Returns a list of the identities (GitHub repo, Package name, Docker images) for an outsider module. Works for modules in development. Requires module to have a file path.

module_identities(flpth = getwd())

Arguments

flpth

File path to location of module

Value

Logical

See also

Examples

library(outsider) # build file structure for an example module module_path <- module_skeleton(program_name = "goldenhind", repo_user = "drake_on_github", docker_user = "drake_on_docker", full_name = 'Sir Francis Drake', email = '[email protected]', service = 'github', flpth = tempdir()) # new path created (module_path)
#> [1] "/tmp/RtmpLHBbZM/om..goldenhind"
# check the generated names and links module_identities(flpth = module_path)
#> R package name: 'om..goldenhind' #> URL: 'https://github.com/drake_on_github/om..goldenhind' #> Docker images: 'drake_on_docker/om_goldenhind:latest'
# check the files are in the right locations module_check(flpth = module_path)
#> DESCRIPTION found ✔ #> R folder with files found ✔ #> inst found ✔ #> inst/om.yml found ✔ #> inst/dockerfiles found ✔ #> inst/dockerfiles/latest with one Dockerfile found ✔
# deliberately break: delete a folder and check again unlink(x = file.path(module_path, 'inst'), recursive = TRUE, force = TRUE) module_check(flpth = module_path)
#> DESCRIPTION found ✔ #> R folder with files found ✔ #> inst not found ✖
# clean-up unlink(x = module_path, recursive = TRUE, force = TRUE)