R/create_model_template.R

In michielvandijk/mapspamc: An R package to create crop distribution maps

#' @title
#' Creates `mapspamc` model template
#'
#' @description
#' `create_model_template` creates a folder structure with template R scripts to implement the various
#' steps to produce crop distribution maps with `mapspamc`.
#'
#' @details
#' `create_model template()` creates nine folders in the `template_path`, set by the user. The folders
#' contain template R scripts to implement the six steps to generate crop distribution
#' maps with `mapspamc`, including: (1) model setup, (2) pre-processing, (3) model preparation,
#' (4) running the model, (5) post-processing and (6) model validation. The user
#' can use the template as a starting point for a country case-study.
#'
#' To run the template scripts, they have to be copied into an RStudio project. We recommend to
#' create such a project first and then use `create_model_template()` to add the scripts to
#' the RStudio project. Note that `create_model_template()` only copies files if they do not exist
#' yet. In this way, the user cannot accidently replace already modified scripts.
#'
#' @param template_path folder where template scripts will be copied.If NULL the current working directory will be used.
#'
#' @examples
#' \dontrun{
#' create_model_template("c:/temp")
#' }
#'
#' @export
create_model_template <- function(template_path = NULL) {
  if (is.null(template_path)) {
    cat("The current working directory will be used: ", getwd())
    template_path <- getwd()
  }
  if (!dir.exists(template_path)) {
    dir.create(template_path, showWarnings = TRUE, recursive = TRUE)
  }

  copy_template_files <- function(template_path) {
    template_files <- list.files(system.file("template", package = "mapspamc"),
      full.names = TRUE, recursive = FALSE
    )
    purrr::walk(template_files, function(x) {
      if (file.exists(x)) {
        file.copy(x, template_path, recursive = TRUE)
      }
    })
  }

  copy_template_files(template_path)

  cat("\n=> model template created in", template_path)
}