setup_r_env: Set up R environment

View source: R/setup_r_env.R

setup_r_envR Documentation

Set up R environment

Description

Set up R environment by (1) clearing the console; (2) removing all objects in the global environment; (3) setting the working directory to the active document (in RStudio only); (4) unloading and loading the kim package.

Usage

setup_r_env(
  clear_console = TRUE,
  clear_global_env = TRUE,
  setwd_to_active_doc = TRUE,
  prep_kim = TRUE
)

Arguments

clear_console

if TRUE, clear the console (default = TRUE)

clear_global_env

if TRUE, remove all objects in the global environment (default = TRUE)

setwd_to_active_doc

if TRUE, set the working directory to the active document in RStudio (default = TRUE)

prep_kim

if TRUE, unload and load the kim package (default = TRUE)

Examples

## Not run: 
setup_r_env()

## End(Not run)

kim documentation built on Oct. 9, 2023, 5:08 p.m.