R/check_df_format.R

In chapmandu2/biotidyr: Tidy functions for MultiAssayExperiment and PharmacoGX objects

#' @title
#' Checks the format of a data frame
#'
#' @description
#' Helper function to determine whether a supplied data frame is a specific \code{\link{data-formats}}
#' defined in the package.  Either returns a boolean or throws a stop.
#'
#' @param df query data frame
#' @param format format to test - see \code{\link{data-formats}}
#' @param dev_mode stop if test is false.  Default is FALSE
#' @return string of data frame type
#' @export check_df_format
#'
#' @examples
#' data(dietlein_data)
#' check_df_format(dietlein_data, 'resp_df')
#'
#' data(example_tall_df)
#' check_df_format(example_tall_df, 'tall_df')
#'
#' data(mtcars)
#' check_df_format(mtcars, 'tall_df')
check_df_format <- function(df, format=NULL, dev_mode=FALSE) {

    stopifnot(is.character(format))

    res <- identical(get_df_format(df), format)

    if(dev_mode & !res) {
        stop(sprintf('data.frame should be in %s format, see ?data_formats', format))
    }

    return(res)

}