R/jjbetweenstats.h.R

In sbalci/ClinicoPathJamoviModule: Analysis for Clinicopathological Research

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

jjbetweenstatsOptions <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "jjbetweenstatsOptions",
    inherit = jmvcore::Options,
    public = list(
        initialize = function(
            dep = NULL,
            group = NULL,
            grvar = NULL,
            centralityplotting = FALSE,
            centralitytype = "parametric",
            typestatistics = "parametric",
            pairwisecomparisons = FALSE,
            pairwisedisplay = "significant",
            padjustmethod = "holm",
            effsizetype = "biased",
            violin = TRUE,
            boxplot = TRUE,
            point = TRUE,
            mytitle = "Within Group Comparison",
            xtitle = "",
            ytitle = "",
            originaltheme = FALSE,
            resultssubtitle = TRUE, ...) {

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

            private$..dep <- jmvcore::OptionVariables$new(
                "dep",
                dep,
                suggested=list(
                    "continuous"),
                permitted=list(
                    "numeric"))
            private$..group <- jmvcore::OptionVariable$new(
                "group",
                group,
                suggested=list(
                    "ordinal",
                    "nominal"),
                permitted=list(
                    "factor"))
            private$..grvar <- jmvcore::OptionVariable$new(
                "grvar",
                grvar,
                suggested=list(
                    "ordinal",
                    "nominal"),
                permitted=list(
                    "factor"),
                default=NULL)
            private$..centralityplotting <- jmvcore::OptionBool$new(
                "centralityplotting",
                centralityplotting,
                default=FALSE)
            private$..centralitytype <- jmvcore::OptionList$new(
                "centralitytype",
                centralitytype,
                options=list(
                    "parametric",
                    "nonparametric",
                    "robust",
                    "bayes"),
                default="parametric")
            private$..typestatistics <- jmvcore::OptionList$new(
                "typestatistics",
                typestatistics,
                options=list(
                    "parametric",
                    "nonparametric",
                    "robust",
                    "bayes"),
                default="parametric")
            private$..pairwisecomparisons <- jmvcore::OptionBool$new(
                "pairwisecomparisons",
                pairwisecomparisons,
                default=FALSE)
            private$..pairwisedisplay <- jmvcore::OptionList$new(
                "pairwisedisplay",
                pairwisedisplay,
                options=list(
                    "significant",
                    "non-significant",
                    "everything"),
                default="significant")
            private$..padjustmethod <- jmvcore::OptionList$new(
                "padjustmethod",
                padjustmethod,
                options=list(
                    "holm",
                    "hochberg",
                    "hommel",
                    "bonferroni",
                    "BH",
                    "BY",
                    "fdr",
                    "none"),
                default="holm")
            private$..effsizetype <- jmvcore::OptionList$new(
                "effsizetype",
                effsizetype,
                options=list(
                    "biased",
                    "unbiased",
                    "eta",
                    "omega"),
                default="biased")
            private$..violin <- jmvcore::OptionBool$new(
                "violin",
                violin,
                default=TRUE)
            private$..boxplot <- jmvcore::OptionBool$new(
                "boxplot",
                boxplot,
                default=TRUE)
            private$..point <- jmvcore::OptionBool$new(
                "point",
                point,
                default=TRUE)
            private$..mytitle <- jmvcore::OptionString$new(
                "mytitle",
                mytitle,
                default="Within Group Comparison")
            private$..xtitle <- jmvcore::OptionString$new(
                "xtitle",
                xtitle,
                default="")
            private$..ytitle <- jmvcore::OptionString$new(
                "ytitle",
                ytitle,
                default="")
            private$..originaltheme <- jmvcore::OptionBool$new(
                "originaltheme",
                originaltheme,
                default=FALSE)
            private$..resultssubtitle <- jmvcore::OptionBool$new(
                "resultssubtitle",
                resultssubtitle,
                default=TRUE)

            self$.addOption(private$..dep)
            self$.addOption(private$..group)
            self$.addOption(private$..grvar)
            self$.addOption(private$..centralityplotting)
            self$.addOption(private$..centralitytype)
            self$.addOption(private$..typestatistics)
            self$.addOption(private$..pairwisecomparisons)
            self$.addOption(private$..pairwisedisplay)
            self$.addOption(private$..padjustmethod)
            self$.addOption(private$..effsizetype)
            self$.addOption(private$..violin)
            self$.addOption(private$..boxplot)
            self$.addOption(private$..point)
            self$.addOption(private$..mytitle)
            self$.addOption(private$..xtitle)
            self$.addOption(private$..ytitle)
            self$.addOption(private$..originaltheme)
            self$.addOption(private$..resultssubtitle)
        }),
    active = list(
        dep = function() private$..dep$value,
        group = function() private$..group$value,
        grvar = function() private$..grvar$value,
        centralityplotting = function() private$..centralityplotting$value,
        centralitytype = function() private$..centralitytype$value,
        typestatistics = function() private$..typestatistics$value,
        pairwisecomparisons = function() private$..pairwisecomparisons$value,
        pairwisedisplay = function() private$..pairwisedisplay$value,
        padjustmethod = function() private$..padjustmethod$value,
        effsizetype = function() private$..effsizetype$value,
        violin = function() private$..violin$value,
        boxplot = function() private$..boxplot$value,
        point = function() private$..point$value,
        mytitle = function() private$..mytitle$value,
        xtitle = function() private$..xtitle$value,
        ytitle = function() private$..ytitle$value,
        originaltheme = function() private$..originaltheme$value,
        resultssubtitle = function() private$..resultssubtitle$value),
    private = list(
        ..dep = NA,
        ..group = NA,
        ..grvar = NA,
        ..centralityplotting = NA,
        ..centralitytype = NA,
        ..typestatistics = NA,
        ..pairwisecomparisons = NA,
        ..pairwisedisplay = NA,
        ..padjustmethod = NA,
        ..effsizetype = NA,
        ..violin = NA,
        ..boxplot = NA,
        ..point = NA,
        ..mytitle = NA,
        ..xtitle = NA,
        ..ytitle = NA,
        ..originaltheme = NA,
        ..resultssubtitle = NA)
)

jjbetweenstatsResults <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "jjbetweenstatsResults",
    inherit = jmvcore::Group,
    active = list(
        todo = function() private$.items[["todo"]],
        plot2 = function() private$.items[["plot2"]],
        plot = function() private$.items[["plot"]]),
    private = list(),
    public=list(
        initialize=function(options) {
            super$initialize(
                options=options,
                name="",
                title="Violin Plots to Compare Between Groups",
                refs=list(
                    "ggplot2",
                    "ggstatsplot",
                    "ClinicoPathJamoviModule"),
                clearWith=list(
                    "dep",
                    "group",
                    "grvar",
                    "originaltheme",
                    "typestatistics",
                    "excl"))
            self$add(jmvcore::Html$new(
                options=options,
                name="todo",
                title="To Do"))
            self$add(jmvcore::Image$new(
                options=options,
                name="plot2",
                title="`Violin Plot by ${grvar}`",
                renderFun=".plot2",
                requiresData=TRUE,
                visible="(grvar)"))
            self$add(jmvcore::Image$new(
                options=options,
                name="plot",
                title="Violin Plot",
                renderFun=".plot",
                requiresData=TRUE))}))

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

#' Box-Violin Plots to Compare Between Groups
#'
#' 
#'
#' @examples
#' \donttest{
#' # example will be added
#'}
#' @param data The data as a data frame.
#' @param dep .
#' @param group .
#' @param grvar .
#' @param centralityplotting .
#' @param centralitytype .
#' @param typestatistics .
#' @param pairwisecomparisons .
#' @param pairwisedisplay .
#' @param padjustmethod .
#' @param effsizetype .
#' @param violin .
#' @param boxplot .
#' @param point .
#' @param mytitle .
#' @param xtitle .
#' @param ytitle .
#' @param originaltheme .
#' @param resultssubtitle .
#' @return A results object containing:
#' \tabular{llllll}{
#'   \code{results$todo} \tab \tab \tab \tab \tab a html \cr
#'   \code{results$plot2} \tab \tab \tab \tab \tab an image \cr
#'   \code{results$plot} \tab \tab \tab \tab \tab an image \cr
#' }
#'
#' @export
jjbetweenstats <- function(
    data,
    dep,
    group,
    grvar = NULL,
    centralityplotting = FALSE,
    centralitytype = "parametric",
    typestatistics = "parametric",
    pairwisecomparisons = FALSE,
    pairwisedisplay = "significant",
    padjustmethod = "holm",
    effsizetype = "biased",
    violin = TRUE,
    boxplot = TRUE,
    point = TRUE,
    mytitle = "Within Group Comparison",
    xtitle = "",
    ytitle = "",
    originaltheme = FALSE,
    resultssubtitle = TRUE) {

    if ( ! requireNamespace("jmvcore", quietly=TRUE))
        stop("jjbetweenstats 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(grvar)) grvar <- jmvcore::resolveQuo(jmvcore::enquo(grvar))
    if (missing(data))
        data <- jmvcore::marshalData(
            parent.frame(),
            `if`( ! missing(dep), dep, NULL),
            `if`( ! missing(group), group, NULL),
            `if`( ! missing(grvar), grvar, NULL))

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

    options <- jjbetweenstatsOptions$new(
        dep = dep,
        group = group,
        grvar = grvar,
        centralityplotting = centralityplotting,
        centralitytype = centralitytype,
        typestatistics = typestatistics,
        pairwisecomparisons = pairwisecomparisons,
        pairwisedisplay = pairwisedisplay,
        padjustmethod = padjustmethod,
        effsizetype = effsizetype,
        violin = violin,
        boxplot = boxplot,
        point = point,
        mytitle = mytitle,
        xtitle = xtitle,
        ytitle = ytitle,
        originaltheme = originaltheme,
        resultssubtitle = resultssubtitle)

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

    analysis$run()

    analysis$results
}