R/plot_scores.R

In tspsyched/autoFC: Automatic Construction of Forced-Choice Tests

#' Scatter Plot for True vs Estimated Scores, True Score vs Absolute Error, etc.
#'
#' @description  This function is a simple plot for diagnostic purposes examining
#' the performance of the FC scale based on simulated data.
#'
#'
#' @param x_scores  Scores to be plotted on the x axis
#' @param y_scores  Scores to be plotted on the y axis
#' @param type  Which type of plots is plotted? Can be \code{"simple"} for simple x-y plot, or \code{"abs.diff"}
#' for plotting absolute difference of (y-x) vs x.
#' @param ...  Other parameters used in \code{plot()}
#' 
#'
#' @details This is only a very crude plot function extending \code{plot()} for demonstrative purposes.
#' Users are free to develop their own versions of plotting.
#'
#' @returns A scatter plot
#'
#' @author Mengtong Li
#'
#' 
#' @examples
#' plot_scores(rnorm(100), rnorm(100))
#'
#' @export
plot_scores <- function(x_scores, y_scores, type = "simple", ...) {
  if (!type %in% c("simple", "abs.diff")) {
    return("type must be in \"simple\" or \"abs.diff\"")
  }
  
  if (type == "simple") {
    plot(x_scores, y_scores, ...)
  }
  else if (type == "abs.diff") {
    plot(x_scores, abs(y_scores - x_scores), ...)       
  }
  
}