R/toolssummary.h.R

In sbalci/ClinicoPathJamoviModule: Analysis for Clinicopathological Research

# This file is automatically generated, you probably don't want to edit this

toolssummaryOptions <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "toolssummaryOptions",
    inherit = jmvcore::Options,
    public = list(
        initialize = function(
            vars = NULL, ...) {

            super$initialize(
                package="ClinicoPath",
                name="toolssummary",
                requiresData=TRUE,
                ...)

            private$..vars <- jmvcore::OptionVariables$new(
                "vars",
                vars)

            self$.addOption(private$..vars)
        }),
    active = list(
        vars = function() private$..vars$value),
    private = list(
        ..vars = NA)
)

toolssummaryResults <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "toolssummaryResults",
    inherit = jmvcore::Group,
    active = list(
        tablestyle4 = function() private$.items[["tablestyle4"]],
        tablestyle4html = function() private$.items[["tablestyle4html"]]),
    private = list(),
    public=list(
        initialize=function(options) {
            super$initialize(
                options=options,
                name="",
                title="Tools for data summary",
                refs=list(
                    "ClinicoPathJamoviModule"))
            self$add(jmvcore::Preformatted$new(
                options=options,
                name="tablestyle4",
                title="toolssummary"))
            self$add(jmvcore::Html$new(
                options=options,
                name="tablestyle4html",
                title="toolssummary"))}))

toolssummaryBase <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "toolssummaryBase",
    inherit = jmvcore::Analysis,
    public = list(
        initialize = function(options, data=NULL, datasetId="", analysisId="", revision=0) {
            super$initialize(
                package = "ClinicoPath",
                name = "toolssummary",
                version = c(1,0,0),
                options = options,
                results = toolssummaryResults$new(options=options),
                data = data,
                datasetId = datasetId,
                analysisId = analysisId,
                revision = revision,
                pause = NULL,
                completeWhenFilled = FALSE,
                requiresMissings = FALSE,
                weightsSupport = 'auto')
        }))

#' Tools for data summary
#'
#' 
#' @param data .
#' @param vars .
#' @return A results object containing:
#' \tabular{llllll}{
#'   \code{results$tablestyle4} \tab \tab \tab \tab \tab a preformatted \cr
#'   \code{results$tablestyle4html} \tab \tab \tab \tab \tab a html \cr
#' }
#'
#' @export
toolssummary <- function(
    data,
    vars) {

    if ( ! requireNamespace("jmvcore", quietly=TRUE))
        stop("toolssummary requires jmvcore to be installed (restart may be required)")

    if ( ! missing(vars)) vars <- jmvcore::resolveQuo(jmvcore::enquo(vars))
    if (missing(data))
        data <- jmvcore::marshalData(
            parent.frame(),
            `if`( ! missing(vars), vars, NULL))


    options <- toolssummaryOptions$new(
        vars = vars)

    analysis <- toolssummaryClass$new(
        options = options,
        data = data)

    analysis$run()

    analysis$results
}