lollipop.h.R

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

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

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

            private$..dep <- jmvcore::OptionVariable$new(
                "dep",
                dep,
                suggested=list(
                    "continuous"),
                permitted=list(
                    "numeric"))
            private$..group <- jmvcore::OptionVariable$new(
                "group",
                group,
                suggested=list(
                    "ordinal",
                    "nominal"),
                permitted=list(
                    "factor"))
            private$..highlight <- jmvcore::OptionLevel$new(
                "highlight",
                highlight,
                variable="(group)")

            self$.addOption(private$..dep)
            self$.addOption(private$..group)
            self$.addOption(private$..highlight)
        }),
    active = list(
        dep = function() private$..dep$value,
        group = function() private$..group$value,
        highlight = function() private$..highlight$value),
    private = list(
        ..dep = NA,
        ..group = NA,
        ..highlight = NA)
)

lollipopResults <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "lollipopResults",
    inherit = jmvcore::Group,
    active = list(
        text = function() private$.items[["text"]],
        plot = function() private$.items[["plot"]]),
    private = list(),
    public=list(
        initialize=function(options) {
            super$initialize(
                options=options,
                name="",
                title="Lollipop Chart",
                refs=list(
                    "ClinicoPathJamoviModule"))
            self$add(jmvcore::Preformatted$new(
                options=options,
                name="text",
                title="Lollipop Chart"))
            self$add(jmvcore::Image$new(
                options=options,
                name="plot",
                title="Lollipop Chart",
                width=600,
                height=450,
                renderFun=".plot",
                requiresData=TRUE))}))

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

#' Lollipop Chart
#'
#' 
#' @param data .
#' @param dep .
#' @param group .
#' @param highlight .
#' @return A results object containing:
#' \tabular{llllll}{
#'   \code{results$text} \tab \tab \tab \tab \tab a preformatted \cr
#'   \code{results$plot} \tab \tab \tab \tab \tab an image \cr
#' }
#'
#' @export
lollipop <- function(
    data,
    dep,
    group,
    highlight) {

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

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

    for (v in group) if (v %in% names(data)) data[[v]] <- as.factor(data[[v]])

    options <- lollipopOptions$new(
        dep = dep,
        group = group,
        highlight = highlight)

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

    analysis$run()

    analysis$results
}