install: Install and uninstall 'rcli' to the R startup process

In HenrikBengtsson/rcli: R Command-Line Interface Extras

Description

Install and uninstall 'rcli' by appending / removing one line of code to the ‘~/.Rprofile’ file.

Usage

install(
  path = "~",
  backup = TRUE,
  overwrite = FALSE,
  quiet = FALSE,
  validate = TRUE
)

uninstall(path = "~", backup = TRUE, quiet = FALSE)

validate()

Arguments

path	The path where to create / update the ‘.Rprofile’ file.
backup	If TRUE, a timestamped backup copy of the original file is created before modifying / overwriting it, otherwise not. If the backup fails, then an error is produced and the R startup file is unmodified.
overwrite	If the R startup file already exist, then FALSE (default) appends the rcli code to the end of the file. is overwritten. If TRUE, any pre-existing R startup file is overwritten.
quiet	If FALSE (default), detailed messages are generated, otherwise not.
validate	If TRUE (default), the installation is validated.

Value

(invisible) The pathname of the R startup file modified.

Functions

• install: injects

  if (nzchar(Sys.getenv("R_CMD")) && require("rcli", quietly=TRUE)) rcli::r_cmd_call()
  

  to the ‘.Rprofile’ file (created if missing).

• uninstall: Remove calls to startup::startup() and similar.

HenrikBengtsson/rcli documentation built on April 28, 2020, 12:36 a.m.