R/jamovicontrastindependent.h.R

Defines functions jamovicontrastindependent

Documented in jamovicontrastindependent

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

jamovicontrastindependentOptions <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "jamovicontrastindependentOptions",
    inherit = jmvcore::Options,
    public = list(
        initialize = function(
            switch = "from_raw",
            group_labels = NULL,
            means = NULL,
            sds = NULL,
            ns = NULL,
            outcome_variable_name = "My Outcome Variable",
            grouping_variable_name = "My Grouping Variable",
            outcome_variables = NULL,
            grouping_variable = NULL,
            reference_labels = " ",
            comparison_labels = " ",
            conf_level = "95",
            assume_equal_variance = FALSE,
            show_details = FALSE,
            show_calculations = FALSE,
            evaluate_hypotheses = FALSE,
            null_boundary = 0.2,
            rope_units = "sd",
            alpha = 0.05,
            es_plot_width = "200",
            es_plot_height = "450",
            eval_plot_width = "300",
            eval_plot_height = "450",
            ymin = "auto",
            ymax = "auto",
            breaks = "auto",
            difference_axis_units = "raw",
            difference_axis_breaks = "auto",
            ylab = "auto",
            xlab = "auto",
            y.axis.text = "10",
            y.axis.title = "12",
            x.axis.text = "10",
            x.axis.title = "12",
            error_layout = "halfeye",
            error_scale = "0.25",
            error_nudge = "0.4",
            data_layout = "random",
            data_spread = "0.25",
            aesthetics_helper = FALSE,
            error_fill_Default = "gray",
            error_alpha_Default = "1",
            ci_colour_Default = "black",
            ci_alpha_Default = "1",
            ci_size_Default = "1",
            data_shape_Reference = "circle filled",
            data_shape_Comparison = "circle filled",
            data_shape_Unused = "triangle filled",
            data_size_Reference = "1",
            data_size_Comparison = "1",
            data_size_Unused = "1",
            data_colour_Reference = "red",
            data_colour_Comparison = "blue",
            data_colour_Unused = "gray",
            data_fill_Reference = "red",
            data_fill_Comparison = "blue",
            data_fill_Unused = "gray",
            data_alpha_Reference = "1",
            data_alpha_Comparison = "1",
            data_alpha_Unused = "1",
            summary_shape_Reference = "circle filled",
            summary_shape_Comparison = "circle filled",
            summary_shape_Difference = "triangle filled",
            summary_shape_Unused = "triangle filled",
            summary_size_Reference = "2",
            summary_size_Comparison = "2",
            summary_size_Difference = "2",
            summary_size_Unused = "2",
            summary_colour_Reference = "red",
            summary_colour_Comparison = "blue",
            summary_colour_Difference = "green",
            summary_colour_Unused = "gray",
            summary_fill_Reference = "red",
            summary_fill_Comparison = "blue",
            summary_fill_Difference = "green",
            summary_fill_Unused = "gray",
            summary_alpha_Reference = "1",
            summary_alpha_Comparison = "1",
            summary_alpha_Difference = "1",
            summary_alpha_Unused = "1", ...) {

            super$initialize(
                package="esci2",
                name="jamovicontrastindependent",
                requiresData=TRUE,
                ...)

            private$..switch <- jmvcore::OptionList$new(
                "switch",
                switch,
                default="from_raw",
                options=list(
                    "from_raw",
                    "from_summary"))
            private$..group_labels <- jmvcore::OptionVariable$new(
                "group_labels",
                group_labels)
            private$..means <- jmvcore::OptionVariable$new(
                "means",
                means)
            private$..sds <- jmvcore::OptionVariable$new(
                "sds",
                sds)
            private$..ns <- jmvcore::OptionVariable$new(
                "ns",
                ns)
            private$..outcome_variable_name <- jmvcore::OptionString$new(
                "outcome_variable_name",
                outcome_variable_name,
                default="My Outcome Variable")
            private$..grouping_variable_name <- jmvcore::OptionString$new(
                "grouping_variable_name",
                grouping_variable_name,
                default="My Grouping Variable")
            private$..outcome_variables <- jmvcore::OptionVariables$new(
                "outcome_variables",
                outcome_variables)
            private$..grouping_variable <- jmvcore::OptionVariable$new(
                "grouping_variable",
                grouping_variable)
            private$..reference_labels <- jmvcore::OptionString$new(
                "reference_labels",
                reference_labels,
                default=" ")
            private$..comparison_labels <- jmvcore::OptionString$new(
                "comparison_labels",
                comparison_labels,
                default=" ")
            private$..conf_level <- jmvcore::OptionString$new(
                "conf_level",
                conf_level,
                default="95")
            private$..assume_equal_variance <- jmvcore::OptionBool$new(
                "assume_equal_variance",
                assume_equal_variance,
                default=FALSE)
            private$..show_details <- jmvcore::OptionBool$new(
                "show_details",
                show_details,
                default=FALSE)
            private$..show_calculations <- jmvcore::OptionBool$new(
                "show_calculations",
                show_calculations,
                default=FALSE)
            private$..evaluate_hypotheses <- jmvcore::OptionBool$new(
                "evaluate_hypotheses",
                evaluate_hypotheses,
                default=FALSE)
            private$..null_boundary <- jmvcore::OptionNumber$new(
                "null_boundary",
                null_boundary,
                min=0,
                default=0.2)
            private$..rope_units <- jmvcore::OptionList$new(
                "rope_units",
                rope_units,
                default="sd",
                options=list(
                    "sd",
                    "raw"))
            private$..alpha <- jmvcore::OptionNumber$new(
                "alpha",
                alpha,
                default=0.05,
                min=0,
                max=1)
            private$..es_plot_width <- jmvcore::OptionString$new(
                "es_plot_width",
                es_plot_width,
                default="200")
            private$..es_plot_height <- jmvcore::OptionString$new(
                "es_plot_height",
                es_plot_height,
                default="450")
            private$..eval_plot_width <- jmvcore::OptionString$new(
                "eval_plot_width",
                eval_plot_width,
                default="300")
            private$..eval_plot_height <- jmvcore::OptionString$new(
                "eval_plot_height",
                eval_plot_height,
                default="450")
            private$..ymin <- jmvcore::OptionString$new(
                "ymin",
                ymin,
                default="auto")
            private$..ymax <- jmvcore::OptionString$new(
                "ymax",
                ymax,
                default="auto")
            private$..breaks <- jmvcore::OptionString$new(
                "breaks",
                breaks,
                default="auto")
            private$..difference_axis_units <- jmvcore::OptionList$new(
                "difference_axis_units",
                difference_axis_units,
                default="raw",
                options=list(
                    "sd",
                    "raw"))
            private$..difference_axis_breaks <- jmvcore::OptionString$new(
                "difference_axis_breaks",
                difference_axis_breaks,
                default="auto")
            private$..ylab <- jmvcore::OptionString$new(
                "ylab",
                ylab,
                default="auto")
            private$..xlab <- jmvcore::OptionString$new(
                "xlab",
                xlab,
                default="auto")
            private$..y.axis.text <- jmvcore::OptionString$new(
                "y.axis.text",
                y.axis.text,
                default="10")
            private$..y.axis.title <- jmvcore::OptionString$new(
                "y.axis.title",
                y.axis.title,
                default="12")
            private$..x.axis.text <- jmvcore::OptionString$new(
                "x.axis.text",
                x.axis.text,
                default="10")
            private$..x.axis.title <- jmvcore::OptionString$new(
                "x.axis.title",
                x.axis.title,
                default="12")
            private$..error_layout <- jmvcore::OptionList$new(
                "error_layout",
                error_layout,
                default="halfeye",
                options=list(
                    "halfeye",
                    "eye",
                    "none"))
            private$..error_scale <- jmvcore::OptionString$new(
                "error_scale",
                error_scale,
                default="0.25")
            private$..error_nudge <- jmvcore::OptionString$new(
                "error_nudge",
                error_nudge,
                default="0.4")
            private$..data_layout <- jmvcore::OptionList$new(
                "data_layout",
                data_layout,
                default="random",
                options=list(
                    "random",
                    "swarm",
                    "none"))
            private$..data_spread <- jmvcore::OptionString$new(
                "data_spread",
                data_spread,
                default="0.25")
            private$..aesthetics_helper <- jmvcore::OptionBool$new(
                "aesthetics_helper",
                aesthetics_helper,
                default=FALSE)
            private$..error_fill_Default <- jmvcore::OptionString$new(
                "error_fill_Default",
                error_fill_Default,
                default="gray")
            private$..error_alpha_Default <- jmvcore::OptionString$new(
                "error_alpha_Default",
                error_alpha_Default,
                default="1")
            private$..ci_colour_Default <- jmvcore::OptionString$new(
                "ci_colour_Default",
                ci_colour_Default,
                default="black")
            private$..ci_alpha_Default <- jmvcore::OptionString$new(
                "ci_alpha_Default",
                ci_alpha_Default,
                default="1")
            private$..ci_size_Default <- jmvcore::OptionString$new(
                "ci_size_Default",
                ci_size_Default,
                default="1")
            private$..data_shape_Reference <- jmvcore::OptionString$new(
                "data_shape_Reference",
                data_shape_Reference,
                default="circle filled")
            private$..data_shape_Comparison <- jmvcore::OptionString$new(
                "data_shape_Comparison",
                data_shape_Comparison,
                default="circle filled")
            private$..data_shape_Unused <- jmvcore::OptionString$new(
                "data_shape_Unused",
                data_shape_Unused,
                default="triangle filled")
            private$..data_size_Reference <- jmvcore::OptionString$new(
                "data_size_Reference",
                data_size_Reference,
                default="1")
            private$..data_size_Comparison <- jmvcore::OptionString$new(
                "data_size_Comparison",
                data_size_Comparison,
                default="1")
            private$..data_size_Unused <- jmvcore::OptionString$new(
                "data_size_Unused",
                data_size_Unused,
                default="1")
            private$..data_colour_Reference <- jmvcore::OptionString$new(
                "data_colour_Reference",
                data_colour_Reference,
                default="red")
            private$..data_colour_Comparison <- jmvcore::OptionString$new(
                "data_colour_Comparison",
                data_colour_Comparison,
                default="blue")
            private$..data_colour_Unused <- jmvcore::OptionString$new(
                "data_colour_Unused",
                data_colour_Unused,
                default="gray")
            private$..data_fill_Reference <- jmvcore::OptionString$new(
                "data_fill_Reference",
                data_fill_Reference,
                default="red")
            private$..data_fill_Comparison <- jmvcore::OptionString$new(
                "data_fill_Comparison",
                data_fill_Comparison,
                default="blue")
            private$..data_fill_Unused <- jmvcore::OptionString$new(
                "data_fill_Unused",
                data_fill_Unused,
                default="gray")
            private$..data_alpha_Reference <- jmvcore::OptionString$new(
                "data_alpha_Reference",
                data_alpha_Reference,
                default="1")
            private$..data_alpha_Comparison <- jmvcore::OptionString$new(
                "data_alpha_Comparison",
                data_alpha_Comparison,
                default="1")
            private$..data_alpha_Unused <- jmvcore::OptionString$new(
                "data_alpha_Unused",
                data_alpha_Unused,
                default="1")
            private$..summary_shape_Reference <- jmvcore::OptionString$new(
                "summary_shape_Reference",
                summary_shape_Reference,
                default="circle filled")
            private$..summary_shape_Comparison <- jmvcore::OptionString$new(
                "summary_shape_Comparison",
                summary_shape_Comparison,
                default="circle filled")
            private$..summary_shape_Difference <- jmvcore::OptionString$new(
                "summary_shape_Difference",
                summary_shape_Difference,
                default="triangle filled")
            private$..summary_shape_Unused <- jmvcore::OptionString$new(
                "summary_shape_Unused",
                summary_shape_Unused,
                default="triangle filled")
            private$..summary_size_Reference <- jmvcore::OptionString$new(
                "summary_size_Reference",
                summary_size_Reference,
                default="2")
            private$..summary_size_Comparison <- jmvcore::OptionString$new(
                "summary_size_Comparison",
                summary_size_Comparison,
                default="2")
            private$..summary_size_Difference <- jmvcore::OptionString$new(
                "summary_size_Difference",
                summary_size_Difference,
                default="2")
            private$..summary_size_Unused <- jmvcore::OptionString$new(
                "summary_size_Unused",
                summary_size_Unused,
                default="2")
            private$..summary_colour_Reference <- jmvcore::OptionString$new(
                "summary_colour_Reference",
                summary_colour_Reference,
                default="red")
            private$..summary_colour_Comparison <- jmvcore::OptionString$new(
                "summary_colour_Comparison",
                summary_colour_Comparison,
                default="blue")
            private$..summary_colour_Difference <- jmvcore::OptionString$new(
                "summary_colour_Difference",
                summary_colour_Difference,
                default="green")
            private$..summary_colour_Unused <- jmvcore::OptionString$new(
                "summary_colour_Unused",
                summary_colour_Unused,
                default="gray")
            private$..summary_fill_Reference <- jmvcore::OptionString$new(
                "summary_fill_Reference",
                summary_fill_Reference,
                default="red")
            private$..summary_fill_Comparison <- jmvcore::OptionString$new(
                "summary_fill_Comparison",
                summary_fill_Comparison,
                default="blue")
            private$..summary_fill_Difference <- jmvcore::OptionString$new(
                "summary_fill_Difference",
                summary_fill_Difference,
                default="green")
            private$..summary_fill_Unused <- jmvcore::OptionString$new(
                "summary_fill_Unused",
                summary_fill_Unused,
                default="gray")
            private$..summary_alpha_Reference <- jmvcore::OptionString$new(
                "summary_alpha_Reference",
                summary_alpha_Reference,
                default="1")
            private$..summary_alpha_Comparison <- jmvcore::OptionString$new(
                "summary_alpha_Comparison",
                summary_alpha_Comparison,
                default="1")
            private$..summary_alpha_Difference <- jmvcore::OptionString$new(
                "summary_alpha_Difference",
                summary_alpha_Difference,
                default="1")
            private$..summary_alpha_Unused <- jmvcore::OptionString$new(
                "summary_alpha_Unused",
                summary_alpha_Unused,
                default="1")

            self$.addOption(private$..switch)
            self$.addOption(private$..group_labels)
            self$.addOption(private$..means)
            self$.addOption(private$..sds)
            self$.addOption(private$..ns)
            self$.addOption(private$..outcome_variable_name)
            self$.addOption(private$..grouping_variable_name)
            self$.addOption(private$..outcome_variables)
            self$.addOption(private$..grouping_variable)
            self$.addOption(private$..reference_labels)
            self$.addOption(private$..comparison_labels)
            self$.addOption(private$..conf_level)
            self$.addOption(private$..assume_equal_variance)
            self$.addOption(private$..show_details)
            self$.addOption(private$..show_calculations)
            self$.addOption(private$..evaluate_hypotheses)
            self$.addOption(private$..null_boundary)
            self$.addOption(private$..rope_units)
            self$.addOption(private$..alpha)
            self$.addOption(private$..es_plot_width)
            self$.addOption(private$..es_plot_height)
            self$.addOption(private$..eval_plot_width)
            self$.addOption(private$..eval_plot_height)
            self$.addOption(private$..ymin)
            self$.addOption(private$..ymax)
            self$.addOption(private$..breaks)
            self$.addOption(private$..difference_axis_units)
            self$.addOption(private$..difference_axis_breaks)
            self$.addOption(private$..ylab)
            self$.addOption(private$..xlab)
            self$.addOption(private$..y.axis.text)
            self$.addOption(private$..y.axis.title)
            self$.addOption(private$..x.axis.text)
            self$.addOption(private$..x.axis.title)
            self$.addOption(private$..error_layout)
            self$.addOption(private$..error_scale)
            self$.addOption(private$..error_nudge)
            self$.addOption(private$..data_layout)
            self$.addOption(private$..data_spread)
            self$.addOption(private$..aesthetics_helper)
            self$.addOption(private$..error_fill_Default)
            self$.addOption(private$..error_alpha_Default)
            self$.addOption(private$..ci_colour_Default)
            self$.addOption(private$..ci_alpha_Default)
            self$.addOption(private$..ci_size_Default)
            self$.addOption(private$..data_shape_Reference)
            self$.addOption(private$..data_shape_Comparison)
            self$.addOption(private$..data_shape_Unused)
            self$.addOption(private$..data_size_Reference)
            self$.addOption(private$..data_size_Comparison)
            self$.addOption(private$..data_size_Unused)
            self$.addOption(private$..data_colour_Reference)
            self$.addOption(private$..data_colour_Comparison)
            self$.addOption(private$..data_colour_Unused)
            self$.addOption(private$..data_fill_Reference)
            self$.addOption(private$..data_fill_Comparison)
            self$.addOption(private$..data_fill_Unused)
            self$.addOption(private$..data_alpha_Reference)
            self$.addOption(private$..data_alpha_Comparison)
            self$.addOption(private$..data_alpha_Unused)
            self$.addOption(private$..summary_shape_Reference)
            self$.addOption(private$..summary_shape_Comparison)
            self$.addOption(private$..summary_shape_Difference)
            self$.addOption(private$..summary_shape_Unused)
            self$.addOption(private$..summary_size_Reference)
            self$.addOption(private$..summary_size_Comparison)
            self$.addOption(private$..summary_size_Difference)
            self$.addOption(private$..summary_size_Unused)
            self$.addOption(private$..summary_colour_Reference)
            self$.addOption(private$..summary_colour_Comparison)
            self$.addOption(private$..summary_colour_Difference)
            self$.addOption(private$..summary_colour_Unused)
            self$.addOption(private$..summary_fill_Reference)
            self$.addOption(private$..summary_fill_Comparison)
            self$.addOption(private$..summary_fill_Difference)
            self$.addOption(private$..summary_fill_Unused)
            self$.addOption(private$..summary_alpha_Reference)
            self$.addOption(private$..summary_alpha_Comparison)
            self$.addOption(private$..summary_alpha_Difference)
            self$.addOption(private$..summary_alpha_Unused)
        }),
    active = list(
        switch = function() private$..switch$value,
        group_labels = function() private$..group_labels$value,
        means = function() private$..means$value,
        sds = function() private$..sds$value,
        ns = function() private$..ns$value,
        outcome_variable_name = function() private$..outcome_variable_name$value,
        grouping_variable_name = function() private$..grouping_variable_name$value,
        outcome_variables = function() private$..outcome_variables$value,
        grouping_variable = function() private$..grouping_variable$value,
        reference_labels = function() private$..reference_labels$value,
        comparison_labels = function() private$..comparison_labels$value,
        conf_level = function() private$..conf_level$value,
        assume_equal_variance = function() private$..assume_equal_variance$value,
        show_details = function() private$..show_details$value,
        show_calculations = function() private$..show_calculations$value,
        evaluate_hypotheses = function() private$..evaluate_hypotheses$value,
        null_boundary = function() private$..null_boundary$value,
        rope_units = function() private$..rope_units$value,
        alpha = function() private$..alpha$value,
        es_plot_width = function() private$..es_plot_width$value,
        es_plot_height = function() private$..es_plot_height$value,
        eval_plot_width = function() private$..eval_plot_width$value,
        eval_plot_height = function() private$..eval_plot_height$value,
        ymin = function() private$..ymin$value,
        ymax = function() private$..ymax$value,
        breaks = function() private$..breaks$value,
        difference_axis_units = function() private$..difference_axis_units$value,
        difference_axis_breaks = function() private$..difference_axis_breaks$value,
        ylab = function() private$..ylab$value,
        xlab = function() private$..xlab$value,
        y.axis.text = function() private$..y.axis.text$value,
        y.axis.title = function() private$..y.axis.title$value,
        x.axis.text = function() private$..x.axis.text$value,
        x.axis.title = function() private$..x.axis.title$value,
        error_layout = function() private$..error_layout$value,
        error_scale = function() private$..error_scale$value,
        error_nudge = function() private$..error_nudge$value,
        data_layout = function() private$..data_layout$value,
        data_spread = function() private$..data_spread$value,
        aesthetics_helper = function() private$..aesthetics_helper$value,
        error_fill_Default = function() private$..error_fill_Default$value,
        error_alpha_Default = function() private$..error_alpha_Default$value,
        ci_colour_Default = function() private$..ci_colour_Default$value,
        ci_alpha_Default = function() private$..ci_alpha_Default$value,
        ci_size_Default = function() private$..ci_size_Default$value,
        data_shape_Reference = function() private$..data_shape_Reference$value,
        data_shape_Comparison = function() private$..data_shape_Comparison$value,
        data_shape_Unused = function() private$..data_shape_Unused$value,
        data_size_Reference = function() private$..data_size_Reference$value,
        data_size_Comparison = function() private$..data_size_Comparison$value,
        data_size_Unused = function() private$..data_size_Unused$value,
        data_colour_Reference = function() private$..data_colour_Reference$value,
        data_colour_Comparison = function() private$..data_colour_Comparison$value,
        data_colour_Unused = function() private$..data_colour_Unused$value,
        data_fill_Reference = function() private$..data_fill_Reference$value,
        data_fill_Comparison = function() private$..data_fill_Comparison$value,
        data_fill_Unused = function() private$..data_fill_Unused$value,
        data_alpha_Reference = function() private$..data_alpha_Reference$value,
        data_alpha_Comparison = function() private$..data_alpha_Comparison$value,
        data_alpha_Unused = function() private$..data_alpha_Unused$value,
        summary_shape_Reference = function() private$..summary_shape_Reference$value,
        summary_shape_Comparison = function() private$..summary_shape_Comparison$value,
        summary_shape_Difference = function() private$..summary_shape_Difference$value,
        summary_shape_Unused = function() private$..summary_shape_Unused$value,
        summary_size_Reference = function() private$..summary_size_Reference$value,
        summary_size_Comparison = function() private$..summary_size_Comparison$value,
        summary_size_Difference = function() private$..summary_size_Difference$value,
        summary_size_Unused = function() private$..summary_size_Unused$value,
        summary_colour_Reference = function() private$..summary_colour_Reference$value,
        summary_colour_Comparison = function() private$..summary_colour_Comparison$value,
        summary_colour_Difference = function() private$..summary_colour_Difference$value,
        summary_colour_Unused = function() private$..summary_colour_Unused$value,
        summary_fill_Reference = function() private$..summary_fill_Reference$value,
        summary_fill_Comparison = function() private$..summary_fill_Comparison$value,
        summary_fill_Difference = function() private$..summary_fill_Difference$value,
        summary_fill_Unused = function() private$..summary_fill_Unused$value,
        summary_alpha_Reference = function() private$..summary_alpha_Reference$value,
        summary_alpha_Comparison = function() private$..summary_alpha_Comparison$value,
        summary_alpha_Difference = function() private$..summary_alpha_Difference$value,
        summary_alpha_Unused = function() private$..summary_alpha_Unused$value),
    private = list(
        ..switch = NA,
        ..group_labels = NA,
        ..means = NA,
        ..sds = NA,
        ..ns = NA,
        ..outcome_variable_name = NA,
        ..grouping_variable_name = NA,
        ..outcome_variables = NA,
        ..grouping_variable = NA,
        ..reference_labels = NA,
        ..comparison_labels = NA,
        ..conf_level = NA,
        ..assume_equal_variance = NA,
        ..show_details = NA,
        ..show_calculations = NA,
        ..evaluate_hypotheses = NA,
        ..null_boundary = NA,
        ..rope_units = NA,
        ..alpha = NA,
        ..es_plot_width = NA,
        ..es_plot_height = NA,
        ..eval_plot_width = NA,
        ..eval_plot_height = NA,
        ..ymin = NA,
        ..ymax = NA,
        ..breaks = NA,
        ..difference_axis_units = NA,
        ..difference_axis_breaks = NA,
        ..ylab = NA,
        ..xlab = NA,
        ..y.axis.text = NA,
        ..y.axis.title = NA,
        ..x.axis.text = NA,
        ..x.axis.title = NA,
        ..error_layout = NA,
        ..error_scale = NA,
        ..error_nudge = NA,
        ..data_layout = NA,
        ..data_spread = NA,
        ..aesthetics_helper = NA,
        ..error_fill_Default = NA,
        ..error_alpha_Default = NA,
        ..ci_colour_Default = NA,
        ..ci_alpha_Default = NA,
        ..ci_size_Default = NA,
        ..data_shape_Reference = NA,
        ..data_shape_Comparison = NA,
        ..data_shape_Unused = NA,
        ..data_size_Reference = NA,
        ..data_size_Comparison = NA,
        ..data_size_Unused = NA,
        ..data_colour_Reference = NA,
        ..data_colour_Comparison = NA,
        ..data_colour_Unused = NA,
        ..data_fill_Reference = NA,
        ..data_fill_Comparison = NA,
        ..data_fill_Unused = NA,
        ..data_alpha_Reference = NA,
        ..data_alpha_Comparison = NA,
        ..data_alpha_Unused = NA,
        ..summary_shape_Reference = NA,
        ..summary_shape_Comparison = NA,
        ..summary_shape_Difference = NA,
        ..summary_shape_Unused = NA,
        ..summary_size_Reference = NA,
        ..summary_size_Comparison = NA,
        ..summary_size_Difference = NA,
        ..summary_size_Unused = NA,
        ..summary_colour_Reference = NA,
        ..summary_colour_Comparison = NA,
        ..summary_colour_Difference = NA,
        ..summary_colour_Unused = NA,
        ..summary_fill_Reference = NA,
        ..summary_fill_Comparison = NA,
        ..summary_fill_Difference = NA,
        ..summary_fill_Unused = NA,
        ..summary_alpha_Reference = NA,
        ..summary_alpha_Comparison = NA,
        ..summary_alpha_Difference = NA,
        ..summary_alpha_Unused = NA)
)

jamovicontrastindependentResults <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "jamovicontrastindependentResults",
    inherit = jmvcore::Group,
    active = list(
        debug = function() private$.items[["debug"]],
        help = function() private$.items[["help"]],
        overview = function() private$.items[["overview"]],
        effect_sizes = function() private$.items[["effect_sizes"]],
        standardized_effect_sizes = function() private$.items[["standardized_effect_sizes"]],
        estimation_plots = function() private$.items[["estimation_plots"]],
        estimation_plot_warnings = function() private$.items[["estimation_plot_warnings"]],
        helper_plot = function() private$.items[["helper_plot"]],
        evaluate_summary = function() private$.items[["evaluate_summary"]],
        evaluation_plot = function() private$.items[["evaluation_plot"]]),
    private = list(),
    public=list(
        initialize=function(options) {
            super$initialize(
                options=options,
                name="",
                title="Estimate Independent Contrast")
            self$add(jmvcore::Preformatted$new(
                options=options,
                name="debug",
                visible=TRUE))
            self$add(jmvcore::Html$new(
                options=options,
                name="help",
                visible=FALSE))
            self$add(jmvcore::Table$new(
                options=options,
                name="overview",
                title="Overview",
                rows=1,
                clearWith=list(
                    "switch",
                    "group_labels",
                    "means",
                    "sds",
                    "ns",
                    "outcome_variable_name",
                    "outcome_variables",
                    "grouping_variable",
                    "reference_labels",
                    "comparison_labels",
                    "conf_level",
                    "assume_equal_variance"),
                columns=list(
                    list(
                        `name`="outcome_variable_name", 
                        `title`="Outcome Variable", 
                        `type`="text", 
                        `combineBelow`=TRUE),
                    list(
                        `name`="group", 
                        `title`="Group", 
                        `type`="text"),
                    list(
                        `name`="m", 
                        `type`="number", 
                        `title`="<i>M</i>"),
                    list(
                        `name`="lower", 
                        `title`="Lower", 
                        `type`="number"),
                    list(
                        `name`="upper", 
                        `title`="Upper", 
                        `type`="number"),
                    list(
                        `name`="median", 
                        `title`="Median", 
                        `type`="number", 
                        `visible`="(show_details & switch == 'from_raw')"),
                    list(
                        `name`="s", 
                        `type`="number", 
                        `title`="<i>s</i>"),
                    list(
                        `name`="min", 
                        `title`="Minimum", 
                        `type`="number", 
                        `visible`="(show_details & switch == 'from_raw')"),
                    list(
                        `name`="max", 
                        `title`="Maximum", 
                        `type`="number", 
                        `visible`="(show_details & switch == 'from_raw')"),
                    list(
                        `name`="q1", 
                        `title`="25th", 
                        `type`="number", 
                        `superTitle`="Percentile", 
                        `visible`="(show_details & switch == 'from_raw')"),
                    list(
                        `name`="q3", 
                        `title`="75th", 
                        `type`="number", 
                        `superTitle`="Percentile", 
                        `visible`="(show_details & switch == 'from_raw')"),
                    list(
                        `name`="n", 
                        `title`="<i>n</i>", 
                        `type`="integer"),
                    list(
                        `name`="missing", 
                        `type`="integer", 
                        `title`="Missing", 
                        `visible`="(switch == 'from_raw')"),
                    list(
                        `name`="df_i", 
                        `title`="<i>df</i>", 
                        `type`="integer", 
                        `visible`="(show_calculations)"),
                    list(
                        `name`="variability_component", 
                        `title`="<i>s</i><sub>p</sub>", 
                        `type`="number", 
                        `visible`="(show_calculations & assume_equal_variance)"),
                    list(
                        `name`="se", 
                        `title`="<i>SE</i>", 
                        `type`="number", 
                        `visible`="(show_calculations)"),
                    list(
                        `name`="moe", 
                        `type`="number", 
                        `title`="<i>MoE</i>", 
                        `visible`="(show_calculations)"))))
            self$add(jmvcore::Table$new(
                options=options,
                name="effect_sizes",
                title="Effect Size Estimates",
                rows=3,
                clearWith=list(
                    "switch",
                    "group_labels",
                    "means",
                    "sds",
                    "ns",
                    "outcome_variable_name",
                    "outcome_variables",
                    "grouping_variable",
                    "reference_labels",
                    "comparison_labels",
                    "conf_level",
                    "assume_equal_variance"),
                columns=list(
                    list(
                        `name`="outcome_variable_name", 
                        `title`="Outcome Variable", 
                        `type`="text", 
                        `combineBelow`=TRUE),
                    list(
                        `name`="effect", 
                        `title`="Effect", 
                        `type`="text"),
                    list(
                        `name`="effect_size", 
                        `type`="number", 
                        `title`="<i>M</i>"),
                    list(
                        `name`="lower", 
                        `title`="Lower", 
                        `type`="number"),
                    list(
                        `name`="upper", 
                        `title`="Upper", 
                        `type`="number"),
                    list(
                        `name`="df", 
                        `title`="<i>df</i>", 
                        `type`="number", 
                        `visible`="(show_calculations & !assume_equal_variance)"),
                    list(
                        `name`="df_i", 
                        `title`="<i>df</i>", 
                        `type`="integer", 
                        `visible`="(show_calculations & assume_equal_variance)"),
                    list(
                        `name`="variability_component", 
                        `title`="<i>s</i><sub>p</sub>", 
                        `type`="number", 
                        `visible`="(show_calculations & assume_equal_variance)"),
                    list(
                        `name`="se", 
                        `title`="<i>SE</i>", 
                        `type`="number", 
                        `visible`="(show_calculations)"),
                    list(
                        `name`="moe", 
                        `type`="number", 
                        `title`="<i>MoE</i>", 
                        `visible`="(show_calculations)"))))
            self$add(jmvcore::Table$new(
                options=options,
                name="standardized_effect_sizes",
                title="Standardized Effect Size Estimates",
                rows=1,
                clearWith=list(
                    "switch",
                    "group_labels",
                    "means",
                    "sds",
                    "ns",
                    "outcome_variable_name",
                    "outcome_variables",
                    "grouping_variable",
                    "reference_labels",
                    "comparison_labels",
                    "conf_level",
                    "assume_equal_variance"),
                columns=list(
                    list(
                        `name`="outcome_variable_name", 
                        `title`="Outcome Variable", 
                        `type`="text", 
                        `combineBelow`=TRUE),
                    list(
                        `name`="effect", 
                        `title`="Effect", 
                        `type`="text"),
                    list(
                        `name`="numerator", 
                        `title`="<i>M</i>", 
                        `type`="number"),
                    list(
                        `name`="denominator", 
                        `title`="Standardizer", 
                        `type`="number"),
                    list(
                        `name`="effect_size", 
                        `type`="number", 
                        `title`="<i>d</i>"),
                    list(
                        `name`="lower", 
                        `title`="Lower", 
                        `type`="number"),
                    list(
                        `name`="upper", 
                        `title`="Upper", 
                        `type`="number"),
                    list(
                        `name`="d_biased", 
                        `title`="<i>d</i><sub>biased</sub>", 
                        `type`="number", 
                        `visible`="(show_calculations)"))))
            self$add(jmvcore::Array$new(
                options=options,
                name="estimation_plots",
                title="Estimation Figures",
                template=jmvcore::Image$new(
                    options=options,
                    title="$key",
                    width=300,
                    height=450,
                    requiresData=TRUE,
                    renderFun=".estimation_plots")))
            self$add(jmvcore::Html$new(
                options=options,
                name="estimation_plot_warnings",
                title="Estimation figure warnings",
                visible=TRUE))
            self$add(jmvcore::Image$new(
                options=options,
                name="helper_plot",
                title="Aesthetics help",
                visible="(aesthetics_helper)",
                width=600,
                height=450,
                renderFun=".helper_plot"))
            self$add(jmvcore::Table$new(
                options=options,
                name="evaluate_summary",
                title="Evaluate Hypotheses",
                rows=1,
                visible="(evaluate_hypotheses)",
                clearWith=list(
                    "switch",
                    "group_labels",
                    "means",
                    "sds",
                    "ns",
                    "outcome_variable_name",
                    "outcome_variables",
                    "grouping_variable",
                    "reference_labels",
                    "comparison_labels",
                    "conf_level",
                    "assume_equal_variance",
                    "null_boundary",
                    "rope_units",
                    "alpha",
                    "evaluate_hypotheses"),
                columns=list(
                    list(
                        `name`="outcome_variable_name", 
                        `title`="Outcome variable", 
                        `type`="text", 
                        `combineBelow`=TRUE),
                    list(
                        `name`="effect_size_label", 
                        `title`="Contrast", 
                        `type`="text", 
                        `combineBelow`=TRUE),
                    list(
                        `name`="null_hypothesis", 
                        `title`="Null Hypothesis", 
                        `type`="text"),
                    list(
                        `name`="t", 
                        `title`="t", 
                        `type`="number"),
                    list(
                        `name`="df", 
                        `title`="df", 
                        `type`="integer"),
                    list(
                        `name`="p", 
                        `title`="p value", 
                        `type`="number", 
                        `format`="zto,pvalue"),
                    list(
                        `name`="alpha", 
                        `title`="\u03B1", 
                        `type`="number", 
                        `format`="zto,pvalue"),
                    list(
                        `name`="conclusion", 
                        `title`="Conclusion", 
                        `type`="text"))))
            self$add(jmvcore::Image$new(
                options=options,
                name="evaluation_plot",
                title="Evaluation Figure",
                visible="(evaluate_hypotheses)",
                width=200,
                height=450,
                requiresData=TRUE,
                renderFun=".evaluation_plot"))}))

jamovicontrastindependentBase <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "jamovicontrastindependentBase",
    inherit = jmvcore::Analysis,
    public = list(
        initialize = function(options, data=NULL, datasetId="", analysisId="", revision=0) {
            super$initialize(
                package = "esci2",
                name = "jamovicontrastindependent",
                version = c(1,0,0),
                options = options,
                results = jamovicontrastindependentResults$new(options=options),
                data = data,
                datasetId = datasetId,
                analysisId = analysisId,
                revision = revision,
                pause = NULL,
                completeWhenFilled = FALSE,
                requiresMissings = FALSE)
        }))

#' Estimate Independent Contrast
#'
#' 
#' @param data .
#' @param switch .
#' @param group_labels .
#' @param means .
#' @param sds .
#' @param ns .
#' @param outcome_variable_name .
#' @param grouping_variable_name .
#' @param outcome_variables .
#' @param grouping_variable .
#' @param reference_labels .
#' @param comparison_labels .
#' @param conf_level .
#' @param assume_equal_variance .
#' @param show_details .
#' @param show_calculations .
#' @param evaluate_hypotheses .
#' @param null_boundary .
#' @param rope_units .
#' @param alpha .
#' @param es_plot_width .
#' @param es_plot_height .
#' @param eval_plot_width .
#' @param eval_plot_height .
#' @param ymin .
#' @param ymax .
#' @param breaks .
#' @param difference_axis_units .
#' @param difference_axis_breaks .
#' @param ylab .
#' @param xlab .
#' @param y.axis.text .
#' @param y.axis.title .
#' @param x.axis.text .
#' @param x.axis.title .
#' @param error_layout .
#' @param error_scale .
#' @param error_nudge .
#' @param data_layout .
#' @param data_spread .
#' @param aesthetics_helper .
#' @param error_fill_Default .
#' @param error_alpha_Default .
#' @param ci_colour_Default .
#' @param ci_alpha_Default .
#' @param ci_size_Default .
#' @param data_shape_Reference .
#' @param data_shape_Comparison .
#' @param data_shape_Unused .
#' @param data_size_Reference .
#' @param data_size_Comparison .
#' @param data_size_Unused .
#' @param data_colour_Reference .
#' @param data_colour_Comparison .
#' @param data_colour_Unused .
#' @param data_fill_Reference .
#' @param data_fill_Comparison .
#' @param data_fill_Unused .
#' @param data_alpha_Reference .
#' @param data_alpha_Comparison .
#' @param data_alpha_Unused .
#' @param summary_shape_Reference .
#' @param summary_shape_Comparison .
#' @param summary_shape_Difference .
#' @param summary_shape_Unused .
#' @param summary_size_Reference .
#' @param summary_size_Comparison .
#' @param summary_size_Difference .
#' @param summary_size_Unused .
#' @param summary_colour_Reference .
#' @param summary_colour_Comparison .
#' @param summary_colour_Difference .
#' @param summary_colour_Unused .
#' @param summary_fill_Reference .
#' @param summary_fill_Comparison .
#' @param summary_fill_Difference .
#' @param summary_fill_Unused .
#' @param summary_alpha_Reference .
#' @param summary_alpha_Comparison .
#' @param summary_alpha_Difference .
#' @param summary_alpha_Unused .
#' @return A results object containing:
#' \tabular{llllll}{
#'   \code{results$debug} \tab \tab \tab \tab \tab a preformatted \cr
#'   \code{results$help} \tab \tab \tab \tab \tab a html \cr
#'   \code{results$overview} \tab \tab \tab \tab \tab a table \cr
#'   \code{results$effect_sizes} \tab \tab \tab \tab \tab a table \cr
#'   \code{results$standardized_effect_sizes} \tab \tab \tab \tab \tab a table \cr
#'   \code{results$estimation_plots} \tab \tab \tab \tab \tab an array of images \cr
#'   \code{results$estimation_plot_warnings} \tab \tab \tab \tab \tab a html \cr
#'   \code{results$helper_plot} \tab \tab \tab \tab \tab an image \cr
#'   \code{results$evaluate_summary} \tab \tab \tab \tab \tab a table \cr
#'   \code{results$evaluation_plot} \tab \tab \tab \tab \tab an image \cr
#' }
#'
#' Tables can be converted to data frames with \code{asDF} or \code{\link{as.data.frame}}. For example:
#'
#' \code{results$overview$asDF}
#'
#' \code{as.data.frame(results$overview)}
#'
#' @export
jamovicontrastindependent <- function(
    data,
    switch = "from_raw",
    group_labels,
    means,
    sds,
    ns,
    outcome_variable_name = "My Outcome Variable",
    grouping_variable_name = "My Grouping Variable",
    outcome_variables,
    grouping_variable,
    reference_labels = " ",
    comparison_labels = " ",
    conf_level = "95",
    assume_equal_variance = FALSE,
    show_details = FALSE,
    show_calculations = FALSE,
    evaluate_hypotheses = FALSE,
    null_boundary = 0.2,
    rope_units = "sd",
    alpha = 0.05,
    es_plot_width = "200",
    es_plot_height = "450",
    eval_plot_width = "300",
    eval_plot_height = "450",
    ymin = "auto",
    ymax = "auto",
    breaks = "auto",
    difference_axis_units = "raw",
    difference_axis_breaks = "auto",
    ylab = "auto",
    xlab = "auto",
    y.axis.text = "10",
    y.axis.title = "12",
    x.axis.text = "10",
    x.axis.title = "12",
    error_layout = "halfeye",
    error_scale = "0.25",
    error_nudge = "0.4",
    data_layout = "random",
    data_spread = "0.25",
    aesthetics_helper = FALSE,
    error_fill_Default = "gray",
    error_alpha_Default = "1",
    ci_colour_Default = "black",
    ci_alpha_Default = "1",
    ci_size_Default = "1",
    data_shape_Reference = "circle filled",
    data_shape_Comparison = "circle filled",
    data_shape_Unused = "triangle filled",
    data_size_Reference = "1",
    data_size_Comparison = "1",
    data_size_Unused = "1",
    data_colour_Reference = "red",
    data_colour_Comparison = "blue",
    data_colour_Unused = "gray",
    data_fill_Reference = "red",
    data_fill_Comparison = "blue",
    data_fill_Unused = "gray",
    data_alpha_Reference = "1",
    data_alpha_Comparison = "1",
    data_alpha_Unused = "1",
    summary_shape_Reference = "circle filled",
    summary_shape_Comparison = "circle filled",
    summary_shape_Difference = "triangle filled",
    summary_shape_Unused = "triangle filled",
    summary_size_Reference = "2",
    summary_size_Comparison = "2",
    summary_size_Difference = "2",
    summary_size_Unused = "2",
    summary_colour_Reference = "red",
    summary_colour_Comparison = "blue",
    summary_colour_Difference = "green",
    summary_colour_Unused = "gray",
    summary_fill_Reference = "red",
    summary_fill_Comparison = "blue",
    summary_fill_Difference = "green",
    summary_fill_Unused = "gray",
    summary_alpha_Reference = "1",
    summary_alpha_Comparison = "1",
    summary_alpha_Difference = "1",
    summary_alpha_Unused = "1") {

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

    if ( ! missing(group_labels)) group_labels <- jmvcore::resolveQuo(jmvcore::enquo(group_labels))
    if ( ! missing(means)) means <- jmvcore::resolveQuo(jmvcore::enquo(means))
    if ( ! missing(sds)) sds <- jmvcore::resolveQuo(jmvcore::enquo(sds))
    if ( ! missing(ns)) ns <- jmvcore::resolveQuo(jmvcore::enquo(ns))
    if ( ! missing(outcome_variables)) outcome_variables <- jmvcore::resolveQuo(jmvcore::enquo(outcome_variables))
    if ( ! missing(grouping_variable)) grouping_variable <- jmvcore::resolveQuo(jmvcore::enquo(grouping_variable))
    if (missing(data))
        data <- jmvcore::marshalData(
            parent.frame(),
            `if`( ! missing(group_labels), group_labels, NULL),
            `if`( ! missing(means), means, NULL),
            `if`( ! missing(sds), sds, NULL),
            `if`( ! missing(ns), ns, NULL),
            `if`( ! missing(outcome_variables), outcome_variables, NULL),
            `if`( ! missing(grouping_variable), grouping_variable, NULL))


    options <- jamovicontrastindependentOptions$new(
        switch = switch,
        group_labels = group_labels,
        means = means,
        sds = sds,
        ns = ns,
        outcome_variable_name = outcome_variable_name,
        grouping_variable_name = grouping_variable_name,
        outcome_variables = outcome_variables,
        grouping_variable = grouping_variable,
        reference_labels = reference_labels,
        comparison_labels = comparison_labels,
        conf_level = conf_level,
        assume_equal_variance = assume_equal_variance,
        show_details = show_details,
        show_calculations = show_calculations,
        evaluate_hypotheses = evaluate_hypotheses,
        null_boundary = null_boundary,
        rope_units = rope_units,
        alpha = alpha,
        es_plot_width = es_plot_width,
        es_plot_height = es_plot_height,
        eval_plot_width = eval_plot_width,
        eval_plot_height = eval_plot_height,
        ymin = ymin,
        ymax = ymax,
        breaks = breaks,
        difference_axis_units = difference_axis_units,
        difference_axis_breaks = difference_axis_breaks,
        ylab = ylab,
        xlab = xlab,
        y.axis.text = y.axis.text,
        y.axis.title = y.axis.title,
        x.axis.text = x.axis.text,
        x.axis.title = x.axis.title,
        error_layout = error_layout,
        error_scale = error_scale,
        error_nudge = error_nudge,
        data_layout = data_layout,
        data_spread = data_spread,
        aesthetics_helper = aesthetics_helper,
        error_fill_Default = error_fill_Default,
        error_alpha_Default = error_alpha_Default,
        ci_colour_Default = ci_colour_Default,
        ci_alpha_Default = ci_alpha_Default,
        ci_size_Default = ci_size_Default,
        data_shape_Reference = data_shape_Reference,
        data_shape_Comparison = data_shape_Comparison,
        data_shape_Unused = data_shape_Unused,
        data_size_Reference = data_size_Reference,
        data_size_Comparison = data_size_Comparison,
        data_size_Unused = data_size_Unused,
        data_colour_Reference = data_colour_Reference,
        data_colour_Comparison = data_colour_Comparison,
        data_colour_Unused = data_colour_Unused,
        data_fill_Reference = data_fill_Reference,
        data_fill_Comparison = data_fill_Comparison,
        data_fill_Unused = data_fill_Unused,
        data_alpha_Reference = data_alpha_Reference,
        data_alpha_Comparison = data_alpha_Comparison,
        data_alpha_Unused = data_alpha_Unused,
        summary_shape_Reference = summary_shape_Reference,
        summary_shape_Comparison = summary_shape_Comparison,
        summary_shape_Difference = summary_shape_Difference,
        summary_shape_Unused = summary_shape_Unused,
        summary_size_Reference = summary_size_Reference,
        summary_size_Comparison = summary_size_Comparison,
        summary_size_Difference = summary_size_Difference,
        summary_size_Unused = summary_size_Unused,
        summary_colour_Reference = summary_colour_Reference,
        summary_colour_Comparison = summary_colour_Comparison,
        summary_colour_Difference = summary_colour_Difference,
        summary_colour_Unused = summary_colour_Unused,
        summary_fill_Reference = summary_fill_Reference,
        summary_fill_Comparison = summary_fill_Comparison,
        summary_fill_Difference = summary_fill_Difference,
        summary_fill_Unused = summary_fill_Unused,
        summary_alpha_Reference = summary_alpha_Reference,
        summary_alpha_Comparison = summary_alpha_Comparison,
        summary_alpha_Difference = summary_alpha_Difference,
        summary_alpha_Unused = summary_alpha_Unused)

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

    analysis$run()

    analysis$results
}
rcalinjageman/esci2 documentation built on Dec. 22, 2021, 1:02 p.m.