readOrMakeObj: Read object from file or make object

In AlejandroKantor/akmisc: Miscellaneous Functions for Data Manipulation

Description

Read object from file or make object

Usage

readOrMakeObj(s_file, makeObj = NULL, ..., b_always_make_obj = FALSE,
  b_message_time = FALSE)

Arguments

s_file	string of file where object is retreaved or saved see details. Must end in .rds.
makeObj	function.
...	additional parameters to be passed to makeObj.
b_always_make_obj	boolean if true makeObj is called regardless of if s_file exists.
b_message_time	boolean, should time ellapsed by messaged.

Details

It is common to produce large objects which take a long time to execute as part of a script. In some cases we would like to retreave these objects but in other cases they need to be constructed again. This function helps with that processes. If s_file exist and b_always_make_obj is false object will be extracted. If s_file does not exist or b_always_make_obj object will be created and saved to s_file.

Value

either the object extracted from s_file or created by makeObj. See details.

Examples

# create a random vector, assign it to v_n_random and save it to file.rds
v_n_random <- readOrMakeObj("file.rds", rnorm, n = 1000000,
                             b_always_make_obj = TRUE, b_message_time = TRUE )

# retreave vector changing a parameter
v_n_random_2 <- readOrMakeObj("file.rds", rnorm, n = 100,
                               b_always_make_obj = FALSE, b_message_time = TRUE )
length(v_n_random_2)
# 1000000 not 100

AlejandroKantor/akmisc documentation built on May 5, 2019, 3:51 a.m.