Assign and save data

Assigns a new object by name to the current working environment then saves the newly assigned object, specified by the "dir" argument.

Usage

assignAndSaveData(
  name,
  object,
  dir = getOption(x = "acid.save.dir", default = getwd()),
  ext = getOption(x = "acid.save.ext", default = "rds"),
  overwrite = getOption(x = "acid.overwrite", default = TRUE),
  compress = getOption(x = "acid.save.compress", default = TRUE),
  envir = parent.frame()
)

Arguments

name

character(1). Desired variable name.

object

Object.

dir

character(1). Directory path.

ext

character(1). Output file format extension.

Supported arguments:

• "rds": R data serialized (RDS).

• "rda": R data (RDA).

RDS is preferred when saving single objects per file, which is always the convention of saveData(), regardless of the extension used.

overwrite

logical(1). Overwrite existing file on disk.

compress

logical(1) or character(1). These character strings are currently allowed for save(): "gzip", "bzip2", or "xz".

envir

environment. Environment to use for assignment. Defaults to parent.frame(), the calling environment.

Value

Invisible named character(1). File path.

Note

This function attempts to follow the same order as assign().

Updated 2022-06-02.

Examples

x <- 1L
dir <- AcidBase::tempdir2()
#> Error in vapply(X = X, FUN = FUN, FUN.VALUE = logical(1L), ..., USE.NAMES = useNames): formal argument "USE.NAMES" matched by multiple actual arguments
assignAndSaveData(
    name = "example",
    object = x,
    dir = dir,
    ext = "rds"
)
#> Error in stop(simpleError(message = msg, call = if (p) {    sys.call(p)})): Assert failure.
#> [1] isCharacter(dir) is not TRUE.
#> Cause: `function` is not character.
exists("example", inherits = FALSE)
#> [1] FALSE
file.exists(file.path(dir, "example.rds"))
#> Error in file.path(dir, "example.rds"): cannot coerce type 'closure' to vector of type 'character'
AcidBase::unlink2(dir)
#> Error in file.exists(x): invalid 'file' argument