creds_to_renviron: Write named keypairs to an _.Renviron_ / _.Rprofile_ file

View source: R/utils_setup.R

creds_to_renvironR Documentation

Write named keypairs to an .Renviron / .Rprofile file

Description

Writes key pairs to .Renviron / .Rprofile and adds .Renviron to .gitignore if not already there.

Usage

creds_to_renviron(
  ...,
  scope = c("user", "project")[1],
  overwrite = FALSE,
  proj_dir = ".",
  rprofile = FALSE
)

Arguments

...

named keys to write

scope

chr Edit globally for the current user, or locally for the current project

overwrite

(lgl) should an existing key pair be overwritten. Default: FALSE

proj_dir

(chr) project directory to write credentials to

rprofile

(lgl) whether to write the keypairs to a options call in a .Rprofile file instead.

Value

success message if a value is written

See Also

Other project setup: fun_docs_table(), ignore_files(), install_remote(), key_pairs_duplicated(), key_pairs_text(), use_UU_reimports(), use_reimport(), write_to_rprofile()


yogat3ch/UU documentation built on May 31, 2024, 10:14 p.m.