R/checkdata.h.R

In sbalci/ClinicoPathJamoviModule: Analysis for Clinicopathological Research

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

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

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

            private$..dep <- jmvcore::OptionVariable$new(
                "dep",
                dep)

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

checkdataResults <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "checkdataResults",
    inherit = jmvcore::Group,
    active = list(
        missingvals = function() private$.items[["missingvals"]],
        minvals = function() private$.items[["minvals"]],
        maxvals = function() private$.items[["maxvals"]]),
    private = list(),
    public=list(
        initialize=function(options) {
            super$initialize(
                options=options,
                name="",
                title="Checking data",
                refs=list(
                    "ClinicoPathJamoviModule"))
            self$add(jmvcore::Preformatted$new(
                options=options,
                name="missingvals",
                title="Missing data"))
            self$add(jmvcore::Table$new(
                options=options,
                name="minvals",
                title="Minimum values",
                rows=5,
                columns=list(
                    list(
                        `name`="minRowNumber", 
                        `title`="Row numbers", 
                        `type`="integer"),
                    list(
                        `name`="minvalues", 
                        `title`="Values", 
                        `type`="number"))))
            self$add(jmvcore::Table$new(
                options=options,
                name="maxvals",
                title="Maximum values",
                rows=5,
                columns=list(
                    list(
                        `name`="maxRowNumber", 
                        `title`="Row numbers", 
                        `type`="integer"),
                    list(
                        `name`="maxvalues", 
                        `title`="Values", 
                        `type`="number"))))}))

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

#' Checking data
#'
#' 
#' @param data .
#' @param dep .
#' @return A results object containing:
#' \tabular{llllll}{
#'   \code{results$missingvals} \tab \tab \tab \tab \tab a preformatted \cr
#'   \code{results$minvals} \tab \tab \tab \tab \tab a table \cr
#'   \code{results$maxvals} \tab \tab \tab \tab \tab a table \cr
#' }
#'
#' Tables can be converted to data frames with \code{asDF} or \code{\link{as.data.frame}}. For example:
#'
#' \code{results$minvals$asDF}
#'
#' \code{as.data.frame(results$minvals)}
#'
#' @export
checkdata <- function(
    data,
    dep) {

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

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


    options <- checkdataOptions$new(
        dep = dep)

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

    analysis$run()

    analysis$results
}