R/simulation_skeleton.R

In simhelpers: Helper Functions for Simulation Studies

#' @title Open a simulation skeleton
#'
#' @description
#' Creates and opens a .R file containing a skeleton for writing a Monte Carlo simulation study.
#'
#'
#' @export
#'
#' @examples
#' \dontrun{
#' create_skeleton()
#' }

create_skeleton <- function() {

  from <- system.file("templates", "simulation_skeleton.R", package = "simhelpers")
  file_contents <- readLines(from, encoding = "UTF-8")

  rstudioapi::documentNew(text = paste0(file_contents, collapse = "\n"), type = "r")

  return(NULL)
}

#------------------------------------------------------