readRDS_vc: Wrapper for readRDS

Description Usage Arguments Value Examples

View source: R/rds.R

Description

This is a wrapper function for readRDS. You can use it exactly as you would readRDS. Internally it checks the data version control file and returns the stamp associated with the current version of the desired 'file'.

Usage

1
readRDS_vc(file, ..., version_control = "DATA_VC", verbose = FALSE)

Arguments

file

a connection or the name of the file where the 'R' object is saved to or read from

...

other params for readRDS see readRDS

version_control

name of data version control file. Default is 'data_vc'. Should match name used in 'make_data_vc'.

verbose

logical, report returned current file version? Default is FALSE

Value

a string 'stamp'_'file'

Examples

1
2
3
make_data_vc()
saveRDS_vc(cars, "my_cars.rds", verbose = TRUE)
readRDS_vc("my_cars.rds", verbose = TRUE)

williamlief/DataVersionControl documentation built on Jan. 6, 2020, 8:20 a.m.