Skip to contents

Get a File Object

Usage

getFile(
  ident,
  from = pwd(),
  addAsLink = TRUE,
  caption = "",
  description = "",
  folderName = "data",
  addIdToName = T
)

Arguments

ident

Path, resource, or entity ID of the file.

from

Used for relative paths. By default, pwd is used (initiated with the step that started improveR).

Creates a link in the inventory if TRUE; improveClean must be run at the end.

caption

By default, entity ID and last modified are the caption; alternative text can be provided here.

description

By default, the filename is the description; alternative text can be provided here.

folderName

By default, data is the subfolder in the workspace where the file is created.

addIdToName

By default, T prepends the entity ID to the name to avoid collisions.

References

ics1141