romRDS: Read or Make RDS

romRDSR Documentation

Read or Make RDS

Description

Reads or makes .rds if file is not available and loads the object into memory.

Usage

romRDS(
  name,
  ...,
  rds_dir = "data/rds",
  rds_dir_ensure = TRUE,
  file_name_sufix = character(0),
  file_name_sufix_var = NULL,
  file_name_sufix_sep = ".",
  file_name_extention = "rds",
  name_has_extention = FALSE,
  rds_compress = FALSE,
  return_name = FALSE,
  do_not_make = FALSE,
  do_not_save = FALSE,
  quietly = FALSE,
  assign_to_name = FALSE
)

Arguments

name

Name of file or object

...

How to construct the object if it is not on disk

rds_dir

Directory where to look for or save to .rds. Default is "data/rds"

rds_dir_ensure

Make rds_dir direcory if it does not exist

file_name_sufix

e.g., date or version.

file_name_sufix_var

Either "date" or "time" for current date and time or NULL (default)

file_name_sufix_sep

Default is "."

file_name_extention

Default is ".rds"

name_has_extention

Default is FALSE

rds_compress

Default is FALSE. It is faster to read and write if rds is not compressed.

return_name

Default is FALSE

do_not_make

Default is FALSE

do_not_save

Default is FALSE

quietly

Default is FALSE

assign_to_name

Default is FALSE

Value

Returns the object or name of the obj (if return_name is TRUE).


stasvlasov/romRDS documentation built on July 31, 2023, 4:36 p.m.