start_kim: Start kim

In jinkim3/kim: A Toolkit for Behavioral Scientists

Start kim

Description

Start kim (update kim; attach default packages; set working directory, etc.) This function requires installing Package 'remotes' v2.4.2 (or possibly a higher version) by Csardi et al. (2021), https://cran.r-project.org/package=remotes

Usage

start_kim(
  update = TRUE,
  upgrade_other_pkg = FALSE,
  setup_r_env = TRUE,
  default_packages = c("data.table", "ggplot2"),
  silent_load_pkgs = c("data.table", "ggplot2")
)

Arguments

update	If update = "force", force updating the package 'kim'. If update = TRUE, compares the currently installed package 'kim' with the most recent version on GitHub and, if the version on GitHub is more recent, ask the user to confirm the update. If confirmed, then update the package. If update = FALSE, skip updating the package. By default, update = "force"
upgrade_other_pkg	input for the upgrade argument to be passed on to remotes::install_github. One of "default", "ask", "always", "never", TRUE, or FALSE. "default" respects the value of the R_REMOTES_UPGRADE environment variable if set, and falls back to "ask" if unset. "ask" prompts the user for which out of date packages to upgrade. For non-interactive sessions "ask" is equivalent to "always". TRUE and FALSE correspond to "always" and "never" respectively. By default, upgrade_other_pkg = FALSE.
setup_r_env	logical. If update = TRUE, runs the function setup_r_env in the package "kim". Type "?kim::setup_r_env" to learn more. By default, setup_r_env = TRUE
default_packages	a vector of names of packages to load and attach. By default, default_packages = c("data.table", "ggplot2")
silent_load_pkgs	a character vector indicating names of packages to load silently (i.e., suppress messages that get printed when loading the packages). By default, silent_load_pkgs = c("data.table", "ggplot2")

Examples

## Not run: 
start_kim()
start_kim(default_packages = c("dplyr", "ggplot2"))
start_kim(update = TRUE, setup_r_env = FALSE)

## End(Not run)

jinkim3/kim documentation built on Feb. 26, 2025, 10:03 a.m.