R/wwwPrep.R

In abbey-thomas/speechcollectr: R Tools for Collecting Speech Production & Perception Data

#' Create the 'www' Directory for a Shiny App
#'
#' @description Many shiny apps for speech experiments require resources (like WAV files) in the www subdirectory. This command takes care of gathering datafiles and putting them in the appropriate directory for
#' @param from A character vector of filenames or a single directory name. Leave `NULL` (default) if you only want to add one of the datasets included in the package.
#' @param is_dir Boolean. Is 'from' a directory?
#' @param path A character vector naming the path to the parent directory of 'www'. Defaults to working directory.
#' @param recordJS Boolean. Should the JavaScript files for audio recording be copied to 'www'? (Not necessary if using any of the speechcollectr audio recording functions)
#' @param volumeCalibration Boolean. Should `cal_noise()` for testing headphone volume be copied to 'www'?
#' @param HugginsPitchScreen Boolean. Should `HugginsPitchData()` for Huggins Pitch Headphone Screen be copied to 'www'?
#' @param AntiphaseScreen Boolean. Should `AntiphaseData()` for Antiphase Headphone Screen be copied to 'www'?
#'
#' @return A www subdirectory in the current working directory. Success messages will be printed in the console as each step towards creating the directory is completed.
#' @export
#'
#' @examples
#' # If you wanted to use the Huggins Pitch Headphone Screen,
#' # You could get the audio in the right place with the following command:
#' wwwPrep(HugginsPitchScreen = TRUE)
#' # But to run this only once, and not put it in your app.R file

wwwPrep <- function(from = NULL, is_dir = FALSE,
                    path = ".",
                    recordJS = FALSE,
                    volumeCalibration = FALSE,
                    HugginsPitchScreen = FALSE,
                    AntiphaseScreen = FALSE){

  if (path == ".") {
    to <- paste0(getwd(), "/www")
  } else {
    if (isTRUE(grepl(".+?/$", path))) {
      to <- paste0(path, "www")
    } else {
      to <- paste0(path, "/www")
    }
  }

  if (!dir.exists("www")) {
    dir.create(path = to)
    cat("Success: Directory 'www' created!")
  }

  if (!is.null(from)) {

    if (isTRUE(is_dir)) {
      from <- gsub("/$", "", from)
      from_dir <- gsub(".*/", "", from)
      if (!dir.exists(paste0(to, "/", from_dir))) {
        dir.create(path = paste0(to, "/", from_dir))
      }
      from <- list.files(path = from, full.names = TRUE)
      cp <- file.copy(from = c(from), to = paste0(to, "/", from_dir),
                      overwrite = TRUE)
    } else {
      cp <- file.copy(from = c(from), to = to, overwrite = TRUE)
    }

    if (all(cp)) {
      cat("Success: All files in 'from' were added to 'www'!")
    }
  }

  if (isTRUE(volumeCalibration)) {
    vol_cal <- cal_noise
    tuneR::writeWave(vol_cal, "www/cal_noise.wav")
    cat("Success: Volume calibration noise WAV added to 'www' as 'cal_noise.wav'.")
  }

  if (isTRUE(recordJS)) {
    rfe <- file.copy(from = system.file("recorder/rec_frontend.js", package = "speechcollectr"),
                         to = "www/rec_frontend.js", overwrite = FALSE)
    rbe <- file.copy(from = system.file("recorder/rec_backend.js", package = "speechcollectr"),
                     to = "www/rec_backend.js", overwrite = FALSE)
    if (isTRUE(rfe) & isTRUE(rbe)) {
      cat("Success: Recording scripts copied to 'www' as 'rec_backend.js' and 'rec_frontend.js'.")
    }
  }

  if (isTRUE(HugginsPitchScreen)) {
    if (!dir.exists("www/hps_audio")) {
      dir.create("www/hps_audio")
    }

    hp_data <- HugginsPitchData
    for (i in 1:14) {
      tuneR::writeWave(hp_data[[i]], filename = paste0("www/hps_audio/", names(hp_data)[i], ".wav"))
    }
    cat("Success: Huggins-Pitch Headphone Screen data added to 'www/hps_audio'! All Huggins Pitch files (12) are prefixed with 'hp_'.")
  }

  if (isTRUE(AntiphaseScreen)) {
    if (!dir.exists("www/hps_audio")) {
      dir.create("www/hps_audio")
    }

    ap_data <- AntiphaseData
    for (i in 1:7) {
      tuneR::writeWave(ap_data[[i]], filename = paste0("www/hps_audio/", names(ap_data)[i], ".wav"))
    }
    cat("Success: Antiphase Headphone Screen data added to 'www/hps_audio'! All antiphase screen files (6) are prefixed with 'ap_'.")
  }

  if (isTRUE(demographics)) {
    demog <- demographics
    utils::write.csv(demog, "www/demographics.csv")
    cat("Success: Demographic survey questionnaire added to 'www' as 'demographics.csv'.")
  }

}