R/validate_config_file.R

In Sage-Bionetworks/mhealthannotator: mhealthtannotator

#' @title Get Synapse Config
#' 
#' @description This is a helper to validate synapse configurations
#' and see whether user has the right inputs for the Shiny App
#' 
#' @param config config
#' @return config file/error messages if config file is invalid
validate_synapse_config <- function(config){
    #'  check synapse config
    tryCatch({
        if(class(config$synapse_tbl_id) != "character"){
            stop("Config Error (synapse table id): parse in character")
        } 
        else if(class(config$output_filename) != "character"){
            stop("Config Error (output filename): parse in character")
        } 
        else if(class(config$filehandle_cols) != "character"){
            stop("Config Error (filehandle_cols): parse in character")
        } 
        else if(class(config$uid) != "character"){
            stop("Config Error (uid): parse in character")
        } 
        else if(class(config$n_batch) != "integer"){
            stop("Config Error (n_batch): parse in integer")
        } 
        else if(class(config$uid) != "character"){
            stop("Config Error (uid): parse in character")
        }else{
            return(config)
        }
    }, error = function(e){
        stop(e$message)
    })
}

#' @title Get Survey Config
#' 
#' @description This is a helper to validate shiny App survey buttons 
#' configurations and see whether user has the 
#' right inputs for the Shiny App
#' 
#' @param config config
#' @return config file/error messages if config file is invalid
validate_survey_config <- function(config){
    available_button_types <- c("radio", 
                                "slider",
                                "checkbox_group")
    button_all_available <- config %>% 
        purrr::map(~.x$type) %>% 
        purrr::reduce(c) %in% 
        available_button_types %>%
        all()
    if(!button_all_available){
        stop("button type not available. Please parse in option of `radio`, `slider`, `checkbox-group`")
    }else{
        return(config)
    }
}


#' @title Validate Config File
#' 
#' @description This is a function to validate the config file 
#' that you will parse for the Shiny App
#' 
#' @param config_path path to configuration file
#' 
#' @return TRUE if config file is already in the right format
validate_config_file <- function(config_path){
    result <- tryCatch({
        config <- config::get(file = config_path)
        app_url <- !is.null(config$app_url)
        team_id <- !is.null(config$team_id)
        synapse_opts <- inherits(
            validate_synapse_config(config$synapse_opts), "list")
        survey_opts <- inherits(
            validate_survey_config(config$survey_opts), "list")
        all(c(app_url, team_id, synapse_opts, survey_opts))  
    }, error = function(e){
        e$message
    })
    
    result_feedback <- list()
    if(result == TRUE){
        result_feedback$success = TRUE
        result_feedback$message = NA
    }else{
        result_feedback$success = FALSE
        result_feedback$message = result
    }
    return(result_feedback)
}