R/toProfile.R

Defines functions toProfile

Documented in toProfile

#' Append to Rprofile in current working directory.
#'
#' Exports the package functionality to .Rprofile in the current working
#' directory. Now the same code you run can be run on another system without
#' requiring any extra installation or throwing errors for uninstalled packages.
#'
#' @param dir Target directory for Rprofile. Defaults to working directory.
#'
#' @param append Whether to append to the current Rprofile, if one exists. Set
#'   to false to overwrite.
#'
#' @export
#'
#' @examples
#' \dontrun{
#' toProfile()
#' }
#'

toProfile <- function(dir = NULL, append = T) {
  contents <- list(body = paste(c("", deparse(body(needs))), collapse = "\n"))
  profileText <- template$render("profile", contents)
  dir <- ifelse(is.null(dir), getwd(), dir)
  path <- file.path(dirname(dir), basename(dir), ".Rprofile")
  cat(profileText, file = path, append = append)
}

Try the needs package in your browser

Any scripts or data that you put into this service are public.

needs documentation built on May 1, 2019, 10:10 p.m.