save_stash: Save an object

View source: R/save_stash.R

save_stashR Documentation

Save an object

Description

Save an object

Usage

save_stash(x, to, save.fn = write.csv, ..., regen.file = TRUE,
  cache.time.stamp = TRUE, cache.uuid = TRUE, simplify = TRUE)

Arguments

x

Object to save

to

Path for where the object will be saved. Accepts a character string or *_stash object.

save.fn

Any function where the first argument is the object and the second is the file path.

...

Arguments to pass to save.fn.

file.name

Base file name for the saved object

time.stamp

TRUE or FALSE. When TRUE, a time stamp will be appended to the file.name. It is recommended to use time.stamp OR uuid, not both. Using both can cause the file name to become very long.

uuid

TRUE or FALSE. When TRUE, a uuid will be appended to the file.name. It is recommended to use time.stamp OR uuid, not both. Using both can cause the file name to become very long.

extension

Extension to append to the file.

compression

Accepts NULL for no compression, or 'gz' for gzip.

checksum

Not being used right now.

Value

List of stash objects that were successfully saved.


jason-huling/rstash documentation built on Aug. 2, 2024, 3:25 p.m.