R/get_template.R

In EngleLab/englelab: EngleLab R Functions

#' Download R Script Templates
#'
#' This function will download template scripts
#' @param to a directory where to download R scripts.
#'     default: "R/templates".
#'     For analysis_script will change to "analyses/templates" if the "analyses
#'     folder exists.
#' @param overwrite Logical. Overwite any existing templates? default: FALSE
#' @param main_script Logical. Download a main script template to source all
#'     other R scripts?
#' @param raw_script Logical. Download template to convert a "messy" raw data
#'     file to a "tidy" raw data file? default = FALSE
#' @param score_script Logical. Download template to perform data cleaning and
#'     scoring on a "tidy" raw data file? default = FALSE
#' @param merge_script Logical. Download template to merge multiple scored data
#'     files? default = FALSE
#' @param analysis_script Logical. Download template to do data analysis (.Rmd)?
#'     default = FALSE
#' @param wmc_scripts Logical. Download all working memory capacity (WMC)
#'     task scripts
#' @param ac_scripts Logical. Download all attention control (AC) task scripts
#' @param path String. working directory file path. Ignore...
#' @export
#'

get_template <- function(to = "R/templates", overwrite = FALSE,
                         main_script = FALSE, raw_script = FALSE,
                         score_script = FALSE, merge_script = FALSE,
                         analysis_script = FALSE,
                         wmc_scripts = FALSE, ac_scripts = FALSE,
                         path = "."){

  ## Setup ####
  to <- paste(path, to, sep = "/")
  github_repo <-
    "https://raw.githubusercontent.com/EngleLab/englelab/master/script_templates/"

  if (!dir.exists(to)) dir.create(to, recursive = TRUE)
  #####

  ## Download Templates
  if (main_script == TRUE) {
    exists <- file.exists(paste(path, "mainscript.qmd", sep = "/"))
    if (exists == TRUE) {
      message("Did not download file. mainscript.qmd already exists")
    } else {
      download.file(paste(github_repo, "mainscript.qmd",
                          sep = ""),
                    paste(path, "mainscript.qmd", sep = "/"))
    }
  }

  if (raw_script == TRUE) {
    exists <- file.exists(paste(to, "1_taskname_raw.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 1_taskname_raw.R already exists")
    } else {
      download.file(paste(github_repo, "1_taskname_raw.R",
                          sep = ""),
                    paste(to, "1_taskname_raw.R", sep = "/"))
    }
  }

  if (score_script == TRUE) {
    exists <- file.exists(paste(to, "2_taskname_score.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 2_taskname_score.R already exists")
    } else {
      download.file(paste(github_repo, "2_taskname_score.R",
                          sep = ""),
                    paste(to, "2_taskname_score.R", sep = "/"))
    }
  }

  if (merge_script == TRUE) {
    exists <- file.exists(paste(to, "3_merge.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 3_merge.R already exists")
    } else {
      download.file(paste(github_repo, "3_merge.R",
                          sep = ""),
                    paste(to, "3_merge.R", sep = "/"))
    }
  }

  if (analysis_script == TRUE) {
    if (dir.exists(paste(path, "analyses", sep = "/"))) {
      if (!dir.exists(paste(path, "analyses/templates", sep = "/"))) {
        dir.create(paste(path, "analyses/templates", sep = "/"), recursive = TRUE)
      }
      analysis_to <- paste(path, "analyses/templates", sep = "/")
    } else {
      analysis_to <- to
    }
    exists <- file.exists(paste(analysis_to, "Analysis_Template.qmd", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. Analysis_Template.qmd already exists")
    } else {
      download.file(paste(github_repo, "Analysis_Template.qmd",
                          sep = ""),
                    paste(analysis_to, "Analysis_Template.qmd", sep = "/"))
    }
  }
  # import scripts from the working memory capacity folder

  if (wmc_scripts == TRUE) {
    if (!dir.exists(paste(to, "working memory capacity", sep = "/"))) {
      dir.create(paste(to, "working memory capacity", sep = "/"),
                 recursive = TRUE)
    }
    wmc_to <- paste(to, "working memory capacity", sep = "/")

    # raw script
    exists <- file.exists(paste(wmc_to, "1_complex_span_raw.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 1_complex_span_raw.R already exists")
    } else {
      download.file(paste(github_repo,
                          "working_memory_capacity/1_complex_span_raw.R",
                          sep = ""),
                    paste(wmc_to, "1_complex_span_raw.R", sep = "/"))
    }

    # symspan score script
    exists <- file.exists(paste(wmc_to, "2_symspan_score.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 2_symspan_score.R already exists")
    } else {
      download.file(paste(github_repo,
                          "working_memory_capacity/2_symspan_score.R",
                          sep = ""),
                    paste(wmc_to, "2_symspan_score.R", sep = "/"))
    }

    # rotspan score script
    exists <- file.exists(paste(wmc_to, "2_rotspan_score.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 2_rotspan_score.R already exists")
    } else {
      download.file(paste(github_repo,
                          "working_memory_capacity/2_rotspan_score.R",
                          sep = ""),
                    paste(wmc_to, "2_rotspan_score.R", sep = "/"))
    }

    # ospan score script
    exists <- file.exists(paste(wmc_to, "2_ospan_score.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 2_ospan_score.R already exists")
    } else {
      download.file(paste(github_repo,
                          "working_memory_capacity/2_ospan_score.R",
                          sep = ""),
                    paste(wmc_to, "2_ospan_score.R", sep = "/"))
    }
  }

  # import scripts from the attention control folder
  if (ac_scripts == TRUE) {
    if (!dir.exists(paste(to, "attention control", sep = "/"))) {
      dir.create(paste(to, "attention control", sep = "/"),
                 recursive = TRUE)
    }
    ac_to <- paste(to, "attention control", sep = "/")

    # raw script
    exists <- file.exists(paste(ac_to, "1_attention_control_raw.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 1_attention_control_raw.R already exists")
    } else {
      download.file(paste(github_repo,
                          "attention_control/1_attention_control_raw.R",
                          sep = ""),
                    paste(ac_to, "1_attention_control_raw.R", sep = "/"))
    }

    # antisaccade score script
    exists <- file.exists(paste(ac_to, "2_antisaccade_score.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 2_antisaccade_score.R already exists")
    } else {
      download.file(paste(github_repo,
                          "attention_control/2_antisaccade_score.R",
                          sep = ""),
                    paste(ac_to, "2_antisaccade_score.R", sep = "/"))
    }

    # visualarrays score script
    exists <- file.exists(paste(ac_to, "2_visualarrays_score.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 2_visualarrays_score.R already exists")
    } else {
      download.file(paste(github_repo,
                          "attention_control/2_visualarrays_score.R",
                          sep = ""),
                    paste(ac_to, "2_visualarrays_score.R", sep = "/"))
    }

    # sact_v2 score script
    exists <- file.exists(paste(ac_to, "2_sact_v2_score.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 2_sact_v2_score.R already exists")
    } else {
      download.file(paste(github_repo,
                          "attention_control/2_sact_v2_score.R",
                          sep = ""),
                    paste(ac_to, "2_sact_v2_score.R", sep = "/"))
    }

    # stroopDL_v2 score script
    exists <- file.exists(paste(ac_to, "2_stroopDL_v2_score.R", sep = "/"))
    if (exists == TRUE & overwrite == FALSE) {
      message("Did not download file. 2_stroopDL_v2_score.R already exists")
    } else {
      download.file(paste(github_repo,
                          "attention_control/2_stroopDL_v2_score.R",
                          sep = ""),
                    paste(ac_to, "2_stroopDL_v2_score.R", sep = "/"))
    }
  }

  #####
}