Skip to contents

User-friendly constructor function for instantiating a FilePath object.

Usage

FilePath(
  name,
  path,
  renders = FALSE,
  stage = NA_character_,
  artifact_role = NA_character_,
  description = NA_character_
)

Arguments

name

Character. User-supplied human-readable name for the file.

path

Character. Absolute or relative file system path.

renders

Logical. Indicates whether the file is a rendered file or rendering script. Defaults to FALSE.

stage

Character. Pipeline lifecycle stage.

artifact_role

Character. Pipeline role of the artifact.

description

Character. Brief description of the file.

Value

A new FilePath object.