R/createCatSumReport.R

In ptl93/AEDA: Automated Exploratory Data Analysis

#' @title Creates a CatSum Report Object
#'
#' @description
#' Directly creates a report object with one command
#'
#' @param id [\code{character(1)}]\cr
#'   ID of the Task Object. \code{\link{makeCatSumTask}}
#' @param data [\code{data.frame}]\cr
#'   A Dataframe with different variables
#' @param target [\code{character(1)}]\cr
#'   Target column. If not available please insert as \code{NULL}.
#' @param ...
#'   Further arguments for makeCatSumTask
#'
#' @export
createCatSumReport = function(id, data, target, ...) {
  cat.sum.task = makeCatSumTask(id = id, data = data,
    target = target, ...)
  cat.sum.result = makeCatSum(cat.sum.task)
  return(makeReport(cat.sum.result))
}