R/clean.R

In sokolhessnerlab/shlab.imgct: Sokol-Hessner Lab image categorization task for R.

#' Clean Function
#'
#' \code{clean} scrubs a list of raw response data consisting of participant
#' codes and images with category choices, where each list item is a TSV file
#' within a directory named "raw". The cleaned data is written to a new "clean"
#' directory with TSV files. Note that if you need finer control over the
#' cleaning of a given type of data export (i.e., Qualtrics), you should use that 
#' data export type's dedicated underlying method.
#'
#' @param path The path relative to working directory that holds data in
#' designated "raw" directory, as well as the "clean" directory for written
#' data files.
#' @param filename The file name prefix for the raw data export from a given
#' source, and must include file extension (TSV). Defaults to "qualtrics_export.tsv".
#' @param source_type The source from which the raw data was exported from.
#' Defaults to "qualtrics".
#'
#' @examples
#' clean("../mounts/imgct/data/csn_imgct")
#' clean("../data", filename = "qualtrics.tsv", source_type = "qualtrics")
#'
#' @export
clean <- function(path, 
                  filename = "qualtrics.tsv", 
                  source_type = "qualtrics") {

  is_tsv <- stringr::str_ends(filename, ".tsv")
  is_accepted <- is_tsv & (source_type == "qualtrics")

  if (is_accepted) {
    shlab.imgct::clean_qualtrics_export(
      path,
      filename,
      qualtrics_tag = "_Q10"
    )
  } else {
    print("Unfortunately, this function only equipped to handle 
          TSV data exported from Qualtrics.")
  }
}