R/use_targets.R

In umr1283/umr1283: UMR 1283 - Project Template

#' Use targets package
#'
#' Setup directory structure for `targets`.
#'
#' @param project A character string. The path to a project.
#' @param ... Not used.
#'
#' @export
use_targets <- function(project = ".", ...) {
  if (nchar(system.file(package = "targets")) == 0) {
    warning('"targets" is not installed!\nrenv::install(c("targets", "gittargets", "visNetwork")) to install it.')
  }

  proj <- normalizePath(project, mustWork = FALSE)

  withr::with_dir(proj, {
    dir.create(
      path = file.path(proj, "_targets"),
      recursive = TRUE, showWarnings = FALSE, mode = "0775"
    )
    dir.create(
      path = file.path(proj, "scripts", "tar-utils"),
      recursive = TRUE, showWarnings = FALSE, mode = "0775"
    )

    writeLines(
      text = c(
        "(function() {",
        "  message(timestamp(quiet = TRUE))",
        "  on.exit(system(paste(\"chown\", \"-R\", \"1000:staff\", targets::tar_store())))",
        "  on.exit(message(timestamp(quiet = TRUE)), add = TRUE)",
        "  targets::tar_make()",
        "})()"
      ),
      con = file.path(proj, "scripts/00-targets.R")
    )

    if (file.exists(file.path(proj, ".Rprofile"))) {
      cat(
        "if (interactive() & nchar(system.file(package = \"targets\")) > 0) {",
        "  library(targets)",
        "  tvn <- function(targets_only = TRUE, ...) targets::tar_visnetwork(targets_only = targets_only, ...)",
        "}",
        "",
        sep = "\n",
        file = file.path(proj, ".Rprofile"),
        append = TRUE
      )
    }

    writeLines(
      text = c(
        paste(c("### global libraries ", rep("=", 79)), collapse = ""),
        "library(targets)",
        "library(here)",
        "library(data.table)",
        "# library(future)",
        "",
        "# targets::tar_renv(extras = \"visNetwork\", path = \"scripts/_dependencies.R\")",
        "",
        "",
        paste(c("### project setup ", rep("=", 82)), collapse = ""),
        "invisible(sapply(",
        "  X = list.files(here(\"scripts\", \"tar-utils\"), pattern = \"^tar-.*R$\", full.names = TRUE),",
        "  FUN = source, echo = FALSE",
        "))",
        "",
        "# plan(multicore, workers = 40)",
        "# message(sprintf(\"Number of workers: %d\", nbrOfWorkers()))",
        "# setDTthreads(threads = 1)",
        "",
        "",
        paste(c("### targets setup ", rep("=", 82)), collapse = ""),
        "tar_setup <- list(",
        "  tar_target(project, dirname(here()), packages = \"here\"),",
        "  tar_target(author, \"UMR1283\")",
        ")",
        "",
        "",
        paste(c("### targets ", rep("=", 88)), collapse = ""),
        "list(",
        "  tar_setup,",
        "  tar_target(start, \"hello!\")",
        ")"
      ),
      con = file.path(proj, "_targets.R")
    )
  })

  invisible(TRUE)
}