Read Stamp in disk

Read Stamp in disk

Usage

stamp_read(
  st_file = NULL,
  st_dir = NULL,
  st_name = NULL,
  st_ext = getOption("stamp.default.ext"),
  stamp_set = FALSE,
  replace = FALSE,
  verbose = getOption("stamp.verbose")
)

Arguments

st_file

character: file path to be read

st_dir

character: parent directory to store stamp file (see details).

st_name

character: name of stamp in file. All stamp files are prefixed with value in option "stamp.stamp_prefix", which by default is "st_". You don't need to add the prefix.

st_ext

character: format of stamp file to save. Default is value in option "stamp.default.ext"

stamp_set

logical: whether to set stamp in .stamp env, using st_name.

replace

Logical: if TRUE and st_name already exists in .stamp environment, it will be replaced with new stamp. If FALSE it gives an error. Default is FALSE

verbose

logical: Fi TRUE displays information about stamping process.

Value

stamp list invisibly

See also

Other stamp functions: stamp_confirm(), stamp_get(), stamp_save(), stamp_set(), stamp_time(), stamp_x_attr()

Examples

if (FALSE) {

x <- data.frame(a = 1:5,
b = letters[1:5])

st_dir <- tempdir()
st_name <- "xst"
sv <- stamp_save(x = x,
st_dir = st_dir,
st_name = st_name)

nsv <- names(sv) |>
 fs::path()

stamp_read(nsv)

}