R/load_all_participant_validations.R

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

#' Load All Participant Validations
#'
#' \code{load_all_participant_validations} loads the TSV at specified full path to the
#' the "results" subdirectory of the desired data path.
#'
#' @param path The path string to the parent directory in which the validation
#' file exists. This should be the same parent directory for "clean" block data.
#'
#' @return all_participant_validations A dataframe consisting of all
#' participants and all validation responses with a total number of correct
#' validations.
#'
#' @examples
#' load_all_participant_validations(path)
#'
#' @export
load_all_participant_validations <- function(path) {

  results_path <- file.path(path, "results")
  filename <- file.path(results_path, "all_participant_validations.tsv")

  if (file.exists(filename)) {
    all_participant_validations <- readr::read_tsv(
      filename,
      col_names = TRUE,
      col_types = readr::cols(.default = readr::col_character())
    )
    return(all_participant_validations)
  } else {
    return("The file you are attempting to load does not exist. 
           Please run `validate_all_participants` at the specified path.")
  }
}