LittleThumb: Automation options

Description Usage Arguments See Also

View source: R/LittleThumb.R

Description

This function sets the default value of arguments used by the main functions of the LittleThumb package.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
LittleThumb(
  rootpath = NULL,
  path = NULL,
  relative = NULL,
  extension = NULL,
  embedded = NULL,
  parent = NULL,
  makedir = NULL,
  reload = NULL,
  rebuild = NULL,
  cleanup = NULL,
  remove = NULL,
  messages = NULL
)

Arguments

rootpath

root location for RDS files. By default rootpath is the current working directory (see getwd).

path

folder location for RDS files. LittleThumb interprets this path either as a sub-directory of the rootpath location, or as an independent location (see relative). By default path is ignored (path = NA).

relative

logical value controlling if the path option is interpreted as a relative location, meaning as a sub-directory of the rootpath location (default = TRUE, yes), or as an independent one.

extension

DO NOT MODIFY: RDS file extension (default = ".rds").

embedded

logical value controlling whether child objects should have their associated RDS files organized into sub-directories corresponding to parent objects (default = TRUE, yes).

parent

environment where the R object should be located. By default parent is the parent.frame of the function being called.

makedir

logical value controlling if non-existing folders should be created automatically when necessary (default = TRUE, yes).

reload

logical value forcing to load R objects from associated RDS files even when these objects already exist in their parent environment (default = FALSE, no).

rebuild

logical value forcing MakeObj to regenerate R objects even when the associated RDS files already exist at the expected locations (default = FALSE, no).

cleanup

logical value controlling wheter MakeObj should remove from the parent environment any additional object created by the provided expression during its evaluation (default = TRUE, yes).

remove

logical value controlling wheter DeleteObj should remove the R object from its parent environment after deleting the associated RDS file (default = TRUE, yes).

messages

logical value enabling or disabling status messages from LittleThumb functions (default = TRUE, enabled).

See Also

MakeObj


benja0x40/LittleThumb documentation built on Jan. 22, 2021, 2:36 p.m.