R/rprofile_clear.R

In mleary/learylib: Personal R package for Matt Leary

#' A function to clear my .Rprofile
#'
#' @param local.rprofile.path character value.  Path to local .Rprofile.  Defaults to
#'     common "~/.Rprofile".
#'
#' @details This function takes an existing Rprofile file and deletes the text.
#'     Note that it checks for the file at the common "~/.Rprofile" location, but can be
#'     manually adjusted for projects, etc.
#'
#' @examples
#' library(learylib)
#'
#' rprofile_clear()  # using default settings
#'
#' @export
#'

rprofile_clear <- function(local.rprofile.path = "~/.Rprofile") {
    if(file.exists(local.rprofile.path)) {
      writeLines("", local.rprofile.path)
      message("Rprofile cleared")
    } else {
      message("Rprofile not found.  Check you file path for local .Rprofile.")
    }
}