R/ModelInterface.R

In wolski/prolfqua: Proteomics Label Free Quantification

# ModelInterface -----
#' R6 interface class representing modelling result
#'
#' @export
#' @examples
#'
#' mi <- ModelInterface$new()
#'
#' testthat::expect_error(mi$get_coefficients())
#' testthat::expect_error(mi$get_anova())
#' testthat::expect_error(mi$coef_histogram())
#' testthat::expect_error(mi$coef_volcano())
#' testthat::expect_error(mi$coef_pairs())
#' testthat::expect_error(mi$anova_histogram())
#'
#'
ModelInterface <- R6::R6Class(
  "ModelInterface",
  public = list(
    #' @description
    #' return model coefficients
    #' @return data.frame
    get_coefficients = function(){
      stop("get_coefficients not implmeneted")
      },
    #' @description
    #' perform ANOVA analysis
    #' @return data.frame
    get_anova = function(){
      stop("get_anova not implmeneted")
      },
    #' @description
    #' plot histogram of coefficients
    #' @return ggplot
    coef_histogram = function(){
      stop("coef_histogram not implmeneted")
      },
    #' @description
    #' plot volcano of coefficients
    #' @return ggplot
    coef_volcano = function(){
      stop("coef_volcano not implmeneted")
      },
    #' @description
    #' pairs plot of coefficients
    #' @return ggplot
    coef_pairs = function(){
      stop("coef_pairs not implmeneted")
      },
    #' @description
    #' histogram of p-values and FDR for anova results
    #' @return ggplot
    anova_histogram = function(){
      stop("anova_histogram not implmeneted")
      }
  )
)