R/biplot_data.R

In priviere/PPBstats: An R package to perform analysis found within PPB programmes

#' Format data for biplot representation 
#'
#' @description
#' \code{biplot_data} formats data for biplot representation 
#' 
#' @param x outputs from 
#' \itemize{
#'  \item \code{\link{check_model.fit_model_GxE}}
#'  \item \code{\link{check_model.fit_model_hedonic}}
#'  \item \code{\link{check_model.fit_model_napping}}
#'  }
#' 
#' @details
#' S3 method.
#' See for more details :
#' \itemize{
#'  \item \code{\link{biplot_data.check_model_GxE}} regarding \code{\link{model_GxE}}
#'  \item \code{\link{biplot_data.check_model_hedonic}} regarding \code{\link{model_hedonic}}
#'  \item \code{\link{biplot_data.check_model_napping}} regarding \code{\link{model_napping}}
#' }
#' 
#' @export
#' 
biplot_data <- function(x) UseMethod("biplot_data")

biplot_data.default <- function(x) {
  ## Method not found
  ## This message needs updating whenever new models are included in PPBstats
  ## TODO: have a list of supported models somewhere, and use it to compose
  ## the error message automatically, or use a more generic message.
  mess = paste(substitute(x),
               "is a model type not yet fully supported by PPBstats")
  stop(mess)
}