use_dockerfile: Use dockerfile template

View source: R/use_dockerfile.R

use_dockerfileR Documentation

Use dockerfile template

Description

Use dockerfile template

Usage

use_dockerfile(
  name,
  person,
  description,
  license = "Artistic-2.0",
  path = tempdir()
)

Arguments

name

'character(1)', name of the image.

person

'person(1)', class person which holds information. Only the maintainer is listed on the LABEL information of the Docker image.

description

'character(1)', description of image.

license

'character(1)', license of image.

path

'character(1)', parent path where folder repository should be created.

Details

The 'use_dockerfile' function is used to create new dockerfiles based on the bioconductor/bioconductor_docker set of images. The function provides a template for creating your image.

Value

invisible

Examples


## detailed example

use_dockerfile(
    name = "custom_image",
    person = person("Foo", "Bar",
        email="foo@bar.com", role = c("aut", "cre")
    ),
    description = "My image",
    license = "GPL",
    path = tempdir()
)

## minimal exmaple
use_dockerfile("custom_image",
    person(
        "abc", "def",
        email = "abc@def.com",
        role = c("cre", "aut")
    )
)


nturaga/BiocDockerManager documentation built on Aug. 31, 2022, 3:21 p.m.