# This file is automatically generated, you probably don't want to edit this
correspondenceOptions <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
"correspondenceOptions",
inherit = jmvcore::Options,
public = list(
initialize = function(
labels = NULL,
vars = NULL,
nd = 2,
chi = TRUE,
eigen = FALSE,
rowvar = "coordinates",
loadingind = FALSE,
colvar = "coordinates",
loadingvar = FALSE,
plot1 = TRUE,
plot2 = FALSE,
plot3 = FALSE,
plot4 = FALSE,
width4 = 500,
height4 = 500,
width3 = 500,
height3 = 500,
width2 = 500,
height2 = 500,
width1 = 500,
height1 = 500, ...) {
super$initialize(
package="snowCluster",
name="correspondence",
requiresData=TRUE,
...)
private$..labels <- jmvcore::OptionVariable$new(
"labels",
labels,
suggested=list(
"nominal",
"id"),
permitted=list(
"id",
"factor"))
private$..vars <- jmvcore::OptionVariables$new(
"vars",
vars,
suggested=list(
"nominal",
"ordinal"),
permitted=list(
"factor"))
private$..nd <- jmvcore::OptionInteger$new(
"nd",
nd,
default=2,
min=2)
private$..chi <- jmvcore::OptionBool$new(
"chi",
chi,
default=TRUE)
private$..eigen <- jmvcore::OptionBool$new(
"eigen",
eigen,
default=FALSE)
private$..rowvar <- jmvcore::OptionList$new(
"rowvar",
rowvar,
options=list(
"coordinates",
"cos2",
"contribution"),
default="coordinates")
private$..loadingind <- jmvcore::OptionBool$new(
"loadingind",
loadingind,
default=FALSE)
private$..colvar <- jmvcore::OptionList$new(
"colvar",
colvar,
options=list(
"coordinates",
"cos2",
"contribution"),
default="coordinates")
private$..loadingvar <- jmvcore::OptionBool$new(
"loadingvar",
loadingvar,
default=FALSE)
private$..plot1 <- jmvcore::OptionBool$new(
"plot1",
plot1,
default=TRUE)
private$..plot2 <- jmvcore::OptionBool$new(
"plot2",
plot2,
default=FALSE)
private$..plot3 <- jmvcore::OptionBool$new(
"plot3",
plot3,
default=FALSE)
private$..plot4 <- jmvcore::OptionBool$new(
"plot4",
plot4,
default=FALSE)
private$..width4 <- jmvcore::OptionInteger$new(
"width4",
width4,
default=500)
private$..height4 <- jmvcore::OptionInteger$new(
"height4",
height4,
default=500)
private$..width3 <- jmvcore::OptionInteger$new(
"width3",
width3,
default=500)
private$..height3 <- jmvcore::OptionInteger$new(
"height3",
height3,
default=500)
private$..width2 <- jmvcore::OptionInteger$new(
"width2",
width2,
default=500)
private$..height2 <- jmvcore::OptionInteger$new(
"height2",
height2,
default=500)
private$..width1 <- jmvcore::OptionInteger$new(
"width1",
width1,
default=500)
private$..height1 <- jmvcore::OptionInteger$new(
"height1",
height1,
default=500)
self$.addOption(private$..labels)
self$.addOption(private$..vars)
self$.addOption(private$..nd)
self$.addOption(private$..chi)
self$.addOption(private$..eigen)
self$.addOption(private$..rowvar)
self$.addOption(private$..loadingind)
self$.addOption(private$..colvar)
self$.addOption(private$..loadingvar)
self$.addOption(private$..plot1)
self$.addOption(private$..plot2)
self$.addOption(private$..plot3)
self$.addOption(private$..plot4)
self$.addOption(private$..width4)
self$.addOption(private$..height4)
self$.addOption(private$..width3)
self$.addOption(private$..height3)
self$.addOption(private$..width2)
self$.addOption(private$..height2)
self$.addOption(private$..width1)
self$.addOption(private$..height1)
}),
active = list(
labels = function() private$..labels$value,
vars = function() private$..vars$value,
nd = function() private$..nd$value,
chi = function() private$..chi$value,
eigen = function() private$..eigen$value,
rowvar = function() private$..rowvar$value,
loadingind = function() private$..loadingind$value,
colvar = function() private$..colvar$value,
loadingvar = function() private$..loadingvar$value,
plot1 = function() private$..plot1$value,
plot2 = function() private$..plot2$value,
plot3 = function() private$..plot3$value,
plot4 = function() private$..plot4$value,
width4 = function() private$..width4$value,
height4 = function() private$..height4$value,
width3 = function() private$..width3$value,
height3 = function() private$..height3$value,
width2 = function() private$..width2$value,
height2 = function() private$..height2$value,
width1 = function() private$..width1$value,
height1 = function() private$..height1$value),
private = list(
..labels = NA,
..vars = NA,
..nd = NA,
..chi = NA,
..eigen = NA,
..rowvar = NA,
..loadingind = NA,
..colvar = NA,
..loadingvar = NA,
..plot1 = NA,
..plot2 = NA,
..plot3 = NA,
..plot4 = NA,
..width4 = NA,
..height4 = NA,
..width3 = NA,
..height3 = NA,
..width2 = NA,
..height2 = NA,
..width1 = NA,
..height1 = NA)
)
correspondenceResults <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
"correspondenceResults",
inherit = jmvcore::Group,
active = list(
instructions = function() private$.items[["instructions"]],
chi = function() private$.items[["chi"]],
eigen = function() private$.items[["eigen"]],
loadingvar = function() private$.items[["loadingvar"]],
loadingind = function() private$.items[["loadingind"]],
plot4 = function() private$.items[["plot4"]],
plot1 = function() private$.items[["plot1"]],
plot2 = function() private$.items[["plot2"]],
plot3 = function() private$.items[["plot3"]]),
private = list(),
public=list(
initialize=function(options) {
super$initialize(
options=options,
name="",
title="Correspondence Analysis",
refs="snowCluster")
self$add(jmvcore::Html$new(
options=options,
name="instructions",
title="Instructions",
visible=TRUE))
self$add(jmvcore::Table$new(
options=options,
name="chi",
title="Chi-square test",
rows=1,
clearWith=list(
"vars",
"labels",
"rowvar",
"colvar",
"nd"),
columns=list(
list(
`name`="name",
`title`="",
`type`="text",
`content`="X-squared"),
list(
`name`="statistic",
`type`="number"),
list(
`name`="df",
`type`="number"),
list(
`name`="p",
`type`="number"))))
self$add(jmvcore::Table$new(
options=options,
name="eigen",
title="Eigenvalues",
visible="(eigen)",
clearWith=list(
"vars",
"labels",
"rowvar",
"colvar",
"nd"),
columns=list(
list(
`name`="comp",
`title`="Component",
`type`="text"),
list(
`name`="eigen",
`title`="Eigenvalue",
`type`="number"),
list(
`name`="varProp",
`title`="% of Variance",
`type`="number"),
list(
`name`="varCum",
`title`="Cumulative %",
`type`="number"))))
self$add(jmvcore::Table$new(
options=options,
name="loadingvar",
title="`Columns across dimensions - ${colvar}`",
visible="(loadingvar)",
rows="(vars)",
clearWith=list(
"vars",
"labels",
"rowvar",
"colvar",
"nd"),
columns=list(
list(
`name`="name",
`title`="",
`type`="text",
`content`="($key)"),
list(
`name`="pc1",
`title`="1",
`type`="number",
`superTitle`="Dimension"))))
self$add(jmvcore::Table$new(
options=options,
name="loadingind",
title="`Rows across dimensions - ${rowvar}`",
visible="(loadingind)",
clearWith=list(
"vars",
"labels",
"rowvar",
"colvar",
"nd"),
columns=list(
list(
`name`="name",
`title`="",
`type`="text",
`content`="($key)"),
list(
`name`="pc1",
`title`="1",
`type`="number",
`superTitle`="Dimension"))))
self$add(jmvcore::Image$new(
options=options,
name="plot4",
title="Scree plot",
requiresData=TRUE,
refs="factoextra",
visible="(plot4)",
renderFun=".plot4",
clearWith=list(
"vars",
"labels",
"rowvar",
"colvar",
"width4",
"height4",
"nd")))
self$add(jmvcore::Image$new(
options=options,
name="plot1",
title="Row points",
requiresData=TRUE,
refs="factoextra",
visible="(plot1)",
renderFun=".plot1",
clearWith=list(
"vars",
"labels",
"rowvar",
"colvar",
"width1",
"height1",
"nd")))
self$add(jmvcore::Image$new(
options=options,
name="plot2",
title="Column points",
requiresData=TRUE,
refs="factoextra",
visible="(plot2)",
renderFun=".plot2",
clearWith=list(
"vars",
"labels",
"rowvar",
"colvar",
"width2",
"height2",
"nd")))
self$add(jmvcore::Image$new(
options=options,
name="plot3",
title="Biplot",
requiresData=TRUE,
refs="factoextra",
visible="(plot3)",
renderFun=".plot3",
clearWith=list(
"vars",
"labels",
"rowvar",
"colvar",
"width3",
"height3",
"nd")))}))
correspondenceBase <- if (requireNamespace("jmvcore", quietly=TRUE)) R6::R6Class(
"correspondenceBase",
inherit = jmvcore::Analysis,
public = list(
initialize = function(options, data=NULL, datasetId="", analysisId="", revision=0) {
super$initialize(
package = "snowCluster",
name = "correspondence",
version = c(1,0,0),
options = options,
results = correspondenceResults$new(options=options),
data = data,
datasetId = datasetId,
analysisId = analysisId,
revision = revision,
pause = NULL,
completeWhenFilled = FALSE,
requiresMissings = FALSE,
weightsSupport = 'auto')
}))
#' Correspondence Analysis
#'
#'
#' @param data The data as a data frame.
#' @param labels .
#' @param vars .
#' @param nd .
#' @param chi .
#' @param eigen .
#' @param rowvar .
#' @param loadingind .
#' @param colvar .
#' @param loadingvar .
#' @param plot1 .
#' @param plot2 .
#' @param plot3 .
#' @param plot4 .
#' @param width4 .
#' @param height4 .
#' @param width3 .
#' @param height3 .
#' @param width2 .
#' @param height2 .
#' @param width1 .
#' @param height1 .
#' @return A results object containing:
#' \tabular{llllll}{
#' \code{results$instructions} \tab \tab \tab \tab \tab a html \cr
#' \code{results$chi} \tab \tab \tab \tab \tab a table \cr
#' \code{results$eigen} \tab \tab \tab \tab \tab a table \cr
#' \code{results$loadingvar} \tab \tab \tab \tab \tab a table \cr
#' \code{results$loadingind} \tab \tab \tab \tab \tab a table \cr
#' \code{results$plot4} \tab \tab \tab \tab \tab an image \cr
#' \code{results$plot1} \tab \tab \tab \tab \tab an image \cr
#' \code{results$plot2} \tab \tab \tab \tab \tab an image \cr
#' \code{results$plot3} \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$chi$asDF}
#'
#' \code{as.data.frame(results$chi)}
#'
#' @export
correspondence <- function(
data,
labels,
vars,
nd = 2,
chi = TRUE,
eigen = FALSE,
rowvar = "coordinates",
loadingind = FALSE,
colvar = "coordinates",
loadingvar = FALSE,
plot1 = TRUE,
plot2 = FALSE,
plot3 = FALSE,
plot4 = FALSE,
width4 = 500,
height4 = 500,
width3 = 500,
height3 = 500,
width2 = 500,
height2 = 500,
width1 = 500,
height1 = 500) {
if ( ! requireNamespace("jmvcore", quietly=TRUE))
stop("correspondence requires jmvcore to be installed (restart may be required)")
if ( ! missing(labels)) labels <- jmvcore::resolveQuo(jmvcore::enquo(labels))
if ( ! missing(vars)) vars <- jmvcore::resolveQuo(jmvcore::enquo(vars))
if (missing(data))
data <- jmvcore::marshalData(
parent.frame(),
`if`( ! missing(labels), labels, NULL),
`if`( ! missing(vars), vars, NULL))
for (v in vars) if (v %in% names(data)) data[[v]] <- as.factor(data[[v]])
options <- correspondenceOptions$new(
labels = labels,
vars = vars,
nd = nd,
chi = chi,
eigen = eigen,
rowvar = rowvar,
loadingind = loadingind,
colvar = colvar,
loadingvar = loadingvar,
plot1 = plot1,
plot2 = plot2,
plot3 = plot3,
plot4 = plot4,
width4 = width4,
height4 = height4,
width3 = width3,
height3 = height3,
width2 = width2,
height2 = height2,
width1 = width1,
height1 = height1)
analysis <- correspondenceClass$new(
options = options,
data = data)
analysis$run()
analysis$results
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.