Load: Load save'd objects and return them as a list

View source: R/Load.R

LoadR Documentation

Load save'd objects and return them as a list

Description

Obects in 'file' are loaded and returned as a value (instead of creating these objects in the global environment). The value can be a list (default) or an environment (if to.list is FALSE); if there is just one object in the file to be read, it is by default unlisted and just the objects' value is returned.

Usage

Load(
  file,
  to.list = TRUE,
  Unlist = TRUE,
  spray = FALSE,
  delete.parent = FALSE,
  Attach = FALSE
)

Arguments

file

the file to load

to.list

if TRUE, a list is returned, otherwise an environment

Unlist

whether to "unlist" length 1 lists (default is TRUE)

spray

whether to create these objects in the global environment (default is FALSE)

delete.parent

if an environment is returned, whether to set its parent env to an empty environment (to make a smaller object)

Attach

to attach the loaded objects to the search path

Details

This is useful to avoid overwriting objects in your workspace, for using only parts of a file, and inspecting the contents of files before you load them. You can set your own names to the objects instead of using the ones from the file. E.g.,

new.name <- Load("manyobjects.rda")$old.name ls(Load("manyobjects.rda"))

Value

a list or environment (depending on to.list) or other object (if there is just one object saved and Unlist equals TRUE) or invisibly NULL if Attach==TRUE

See Also

load


lebatsnok/hammock documentation built on Dec. 2, 2022, 6:25 a.m.