scandal_save_data: Saves a data object as an RDS file

Description Usage Arguments Details Value Author(s)

View source: R/utils.R

Description

Saves a data object as an RDS files, possibly into a specified sub-directory. Creates the sub-directory if it is missing.

Usage

1
2
3
4
5
6
7
8
scandal_save_data(
  object,
  filename,
  dirname = ".",
  project_dir = ".",
  data_dir = "data",
  verbose = FALSE
)

Arguments

object

an object to be saved as a RDS file.

filename

the name of the file **without .RDS suffix**.

dirname

a sub-directory to which the object will be saved. Default is ".", meaning no sub-directory will be used.

project_dir

the root directory of the current project to which all data files are saved. Default is NULL meaning that the files will be saved to the working directory.

data_dir

a subdirectory in project_dir to which all data files are saved. Default is "data".

verbose

suppresses all messages from this function. Default is FALSE.

Details

Saves a data object as an RDS files, possibly into a specified sub-directory. Creates the sub-directory if it is missing.

Value

Invisibly returns NULL.

Author(s)

Avishay Spitzer


dravishays/scandal documentation built on Jan. 8, 2020, 1:30 p.m.