R/copy_file_config_ini_new.R

In addinsOutline: 'RStudio' Addins for Show Outline of a R Markdown/'LaTeX' Project

#' Copy Configuration File from Outline in Working Directory
#'
#' Copy configuration file from outline in working directory
#' to search for additional terms in our R Markdown or LaTeX project.
#'
#' The name of the configuration file is "addinsOutline_ini.txt".
#'
#' In the configuration file you can use regular expressions with the help
#' of the functions of the "stringr" package,
#' to perform additional custom searches.
#'
#' Make a copy of this file to see how new searches are defined.
#'
#' The following strings serve to distinguish which types of files will be used:
#'
#' - "rmd": R Markdown files
#'
#' - "rmdbd": Bookdown files
#'
#' - "tex": LaTeX files
#'
#' @param path_to path where the configuration file will be copied
#' @param overwritefile logical variable;  if \code{TRUE} will overwrite the file if it already exists
#'
#' @return Copy configuration file from outline in working directory
#'
#' @seealso The function \code{\link{run_addinsOutline_Rmd}()},
#' \code{\link{run_addinsOutline_Rmd_bookdown}()} and
#' \code{\link{run_addinsOutline_tex}()}.
#'
#' @examples
#' if (interactive()) {
#'    library(addinsOutline)
#'    copy_file_config_ini_new()
#' }
#' @export
copy_file_config_ini_new <- function(path_to=NULL,overwritefile = TRUE) {

  if (is.null(path_to)) {
     file.copy(from=paste(system.file("templates",package="addinsOutline"),
                       "addinsOutline_ini.txt",sep="/"),
            to="./",
            overwrite = overwritefile)
  } else {
    file.copy(from=paste(system.file("templates",package="addinsOutline"),
                         "addinsOutline_ini.txt",sep="/"),
              to=path_to,
              overwrite = overwritefile)
  }

}