R/simian.h.R

In LizXSam/SimiAn:

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

simiAnOptions <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "simiAnOptions",
    inherit = jmvcore::Options,
    public = list(
        initialize = function(
            sotext = NULL,
            tatext = NULL,
            sort = TRUE,
            dischoice = "top5", ...) {

            super$initialize(
                package="SimiAn",
                name="simiAn",
                requiresData=TRUE,
                ...)

            private$..sotext <- jmvcore::OptionVariables$new(
                "sotext",
                sotext)
            private$..tatext <- jmvcore::OptionVariables$new(
                "tatext",
                tatext)
            private$..sort <- jmvcore::OptionBool$new(
                "sort",
                sort,
                default=TRUE)
            private$..dischoice <- jmvcore::OptionList$new(
                "dischoice",
                dischoice,
                options=list(
                    "top5",
                    "top10"),
                default="top5")

            self$.addOption(private$..sotext)
            self$.addOption(private$..tatext)
            self$.addOption(private$..sort)
            self$.addOption(private$..dischoice)
        }),
    active = list(
        sotext = function() private$..sotext$value,
        tatext = function() private$..tatext$value,
        sort = function() private$..sort$value,
        dischoice = function() private$..dischoice$value),
    private = list(
        ..sotext = NA,
        ..tatext = NA,
        ..sort = NA,
        ..dischoice = NA)
)

simiAnResults <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
    "simiAnResults",
    inherit = jmvcore::Group,
    active = list(
        text = function() private$.items[["text"]]),
    private = list(),
    public=list(
        initialize=function(options) {
            super$initialize(
                options=options,
                name="",
                title="Text Similarity Scoring")
            self$add(jmvcore::Preformatted$new(
                options=options,
                name="text",
                title="Text Similarity Scoring"))}))

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

#' Text Similarity Scoring
#'
#' 
#' @param data .
#' @param sotext .
#' @param tatext .
#' @param sort .
#' @param dischoice .
#' @return A results object containing:
#' \tabular{llllll}{
#'   \code{results$text} \tab \tab \tab \tab \tab a preformatted \cr
#' }
#'
#' @export
simiAn <- function(
    data,
    sotext,
    tatext,
    sort = TRUE,
    dischoice = "top5") {

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

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


    options <- simiAnOptions$new(
        sotext = sotext,
        tatext = tatext,
        sort = sort,
        dischoice = dischoice)

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

    analysis$run()

    analysis$results
}