# This file is automatically generated, you probably don't want to edit this
metaProportionOptions <- if (requireNamespace('jmvcore')) R6::R6Class(
"metaProportionOptions",
inherit = jmvcore::Options,
public = list(
initialize = function(
xi = NULL,
ni = NULL,
slab = NULL,
moderatorcor = NULL,
methodmetacor = "REML",
cormeasure = "PR",
moderatorType = "NON",
level = 95,
showModelFit = FALSE,
addcred = FALSE,
addfit = TRUE,
showweights = FALSE,
steps = 5,
xAxisTitle = NULL,
pchForest = "15",
forestOrder = "fit",
fsntype = "Rosenthal",
yaxis = "sei",
yaxisInv = FALSE,
enhanceFunnel = FALSE, ...) {
super$initialize(
package='MAJOR',
name='metaProportion',
requiresData=TRUE,
...)
private$..xi <- jmvcore::OptionVariable$new(
"xi",
xi,
suggested=list(
"continuous"),
permitted=list(
"numeric"))
private$..ni <- jmvcore::OptionVariable$new(
"ni",
ni,
suggested=list(
"continuous"),
permitted=list(
"numeric"))
private$..slab <- jmvcore::OptionVariable$new(
"slab",
slab,
suggested=list(
"nominal"))
private$..moderatorcor <- jmvcore::OptionVariable$new(
"moderatorcor",
moderatorcor,
suggested=list(
"continuous"),
permitted=list(
"numeric"))
private$..methodmetacor <- jmvcore::OptionList$new(
"methodmetacor",
methodmetacor,
options=list(
"DL",
"HE",
"HS",
"SJ",
"ML",
"REML",
"EB",
"PM",
"FE"),
default="REML")
private$..cormeasure <- jmvcore::OptionList$new(
"cormeasure",
cormeasure,
options=list(
"PR",
"PLN",
"PLO",
"PAS",
"PFT"),
default="PR")
private$..moderatorType <- jmvcore::OptionList$new(
"moderatorType",
moderatorType,
options=list(
"NON",
"CAT",
"CON"),
default="NON")
private$..level <- jmvcore::OptionNumber$new(
"level",
level,
min=50,
max=99.9,
default=95)
private$..showModelFit <- jmvcore::OptionBool$new(
"showModelFit",
showModelFit,
default=FALSE)
private$..addcred <- jmvcore::OptionBool$new(
"addcred",
addcred,
default=FALSE)
private$..addfit <- jmvcore::OptionBool$new(
"addfit",
addfit,
default=TRUE)
private$..showweights <- jmvcore::OptionBool$new(
"showweights",
showweights,
default=FALSE)
private$..steps <- jmvcore::OptionNumber$new(
"steps",
steps,
min=1,
max=999,
default=5)
private$..xAxisTitle <- jmvcore::OptionString$new(
"xAxisTitle",
xAxisTitle)
private$..pchForest <- jmvcore::OptionList$new(
"pchForest",
pchForest,
options=list(
"16",
"18",
"15",
"17",
"1",
"5",
"0",
"2",
"8"),
default="15")
private$..forestOrder <- jmvcore::OptionList$new(
"forestOrder",
forestOrder,
options=list(
"obs",
"fit",
"prec",
"resid",
"abs.resid"),
default="fit")
private$..fsntype <- jmvcore::OptionList$new(
"fsntype",
fsntype,
options=list(
"Rosenthal",
"Orwin",
"Rosenberg"),
default="Rosenthal")
private$..yaxis <- jmvcore::OptionList$new(
"yaxis",
yaxis,
options=list(
"sei",
"vi",
"ni",
"sqrtni",
"lni"),
default="sei")
private$..yaxisInv <- jmvcore::OptionBool$new(
"yaxisInv",
yaxisInv,
default=FALSE)
private$..enhanceFunnel <- jmvcore::OptionBool$new(
"enhanceFunnel",
enhanceFunnel,
default=FALSE)
self$.addOption(private$..xi)
self$.addOption(private$..ni)
self$.addOption(private$..slab)
self$.addOption(private$..moderatorcor)
self$.addOption(private$..methodmetacor)
self$.addOption(private$..cormeasure)
self$.addOption(private$..moderatorType)
self$.addOption(private$..level)
self$.addOption(private$..showModelFit)
self$.addOption(private$..addcred)
self$.addOption(private$..addfit)
self$.addOption(private$..showweights)
self$.addOption(private$..steps)
self$.addOption(private$..xAxisTitle)
self$.addOption(private$..pchForest)
self$.addOption(private$..forestOrder)
self$.addOption(private$..fsntype)
self$.addOption(private$..yaxis)
self$.addOption(private$..yaxisInv)
self$.addOption(private$..enhanceFunnel)
}),
active = list(
xi = function() private$..xi$value,
ni = function() private$..ni$value,
slab = function() private$..slab$value,
moderatorcor = function() private$..moderatorcor$value,
methodmetacor = function() private$..methodmetacor$value,
cormeasure = function() private$..cormeasure$value,
moderatorType = function() private$..moderatorType$value,
level = function() private$..level$value,
showModelFit = function() private$..showModelFit$value,
addcred = function() private$..addcred$value,
addfit = function() private$..addfit$value,
showweights = function() private$..showweights$value,
steps = function() private$..steps$value,
xAxisTitle = function() private$..xAxisTitle$value,
pchForest = function() private$..pchForest$value,
forestOrder = function() private$..forestOrder$value,
fsntype = function() private$..fsntype$value,
yaxis = function() private$..yaxis$value,
yaxisInv = function() private$..yaxisInv$value,
enhanceFunnel = function() private$..enhanceFunnel$value),
private = list(
..xi = NA,
..ni = NA,
..slab = NA,
..moderatorcor = NA,
..methodmetacor = NA,
..cormeasure = NA,
..moderatorType = NA,
..level = NA,
..showModelFit = NA,
..addcred = NA,
..addfit = NA,
..showweights = NA,
..steps = NA,
..xAxisTitle = NA,
..pchForest = NA,
..forestOrder = NA,
..fsntype = NA,
..yaxis = NA,
..yaxisInv = NA,
..enhanceFunnel = NA)
)
metaProportionResults <- if (requireNamespace('jmvcore')) R6::R6Class(
inherit = jmvcore::Group,
active = list(
textRICH = function() private$.items[["textRICH"]],
tableTauSqaured = function() private$.items[["tableTauSqaured"]],
modelFitRICH = function() private$.items[["modelFitRICH"]],
plot = function() private$.items[["plot"]],
pubBias = function() private$.items[["pubBias"]],
funplot = function() private$.items[["funplot"]]),
private = list(),
public=list(
initialize=function(options) {
super$initialize(
options=options,
name="",
title="Proportions")
self$add(jmvcore::Table$new(
options=options,
name="textRICH",
title="Random-Effects Model",
refs=list(
"metafor"),
rows=2,
columns=list(
list(
`name`="Intercept",
`title`="",
`type`="text"),
list(
`name`="Estimate",
`type`="number"),
list(
`name`="se",
`type`="number"),
list(
`name`="Z",
`type`="number"),
list(
`name`="p",
`type`="number",
`format`="zto,pvalue"),
list(
`name`="CILow",
`title`="CI Lower Bound",
`type`="number",
`format`="zto"),
list(
`name`="CIHigh",
`title`="CI Upper Bound",
`type`="number",
`format`="zto"))))
self$add(jmvcore::Table$new(
options=options,
name="tableTauSqaured",
title="Heterogeneity Statistics",
rows=1,
columns=list(
list(
`name`="tauSQRT",
`title`="Tau",
`type`="number",
`format`="zto"),
list(
`name`="tauSqComb",
`title`="Tau\u00B2",
`type`="number",
`format`="zto"),
list(
`name`="ISqu",
`title`="I\u00B2",
`type`="text"),
list(
`name`="HSqu",
`title`="H\u00B2",
`type`="number",
`format`="zto"),
list(
`name`="RSqu",
`title`="R\u00B2",
`type`="text"),
list(
`name`="QallDF",
`title`="df",
`type`="integer",
`format`="zto"),
list(
`name`="Qall",
`title`="Q",
`type`="number",
`format`="zto"),
list(
`name`="QallPval",
`title`="p",
`type`="number",
`format`="zto,pvalue"))))
self$add(jmvcore::Table$new(
options=options,
name="modelFitRICH",
title="Model Fit Statistics and Information Criteria",
rows=2,
columns=list(
list(
`name`="label",
`title`="",
`type`="text"),
list(
`name`="loglikelihood",
`title`="log-likelihood",
`type`="number",
`format`="zto"),
list(
`name`="deviance",
`title`="Deviance",
`type`="number",
`format`="zto"),
list(
`name`="AIC",
`type`="number",
`format`="zto"),
list(
`name`="BIC",
`type`="number",
`format`="zto"),
list(
`name`="AICc",
`type`="number",
`format`="zto"))))
self$add(jmvcore::Image$new(
options=options,
name="plot",
title="Forest Plot",
width=600,
height=450,
renderFun=".plot",
refs=list(
"metafor")))
self$add(R6::R6Class(
inherit = jmvcore::Group,
active = list(
fsnRICH = function() private$.items[["fsnRICH"]],
rankRICH = function() private$.items[["rankRICH"]],
regRICH = function() private$.items[["regRICH"]]),
private = list(),
public=list(
initialize=function(options) {
super$initialize(
options=options,
name="pubBias",
title="Publication Bias Assessment")
self$add(jmvcore::Table$new(
options=options,
name="fsnRICH",
title="Fail-Safe N Analysis",
rows=1,
columns=list(
list(
`name`="failSafeNumber",
`title`="Fail-safe N",
`type`="integer",
`format`="zto"),
list(
`name`="p",
`type`="number",
`format`="zto,pvalue"))))
self$add(jmvcore::Table$new(
options=options,
name="rankRICH",
title="Rank Correlation Test for Funnel Plot Asymmetry",
rows=1,
columns=list(
list(
`name`="rankTau",
`title`="Kendall's Tau",
`type`="number",
`format`="zto"),
list(
`name`="p",
`type`="number",
`format`="zto,pvalue"))))
self$add(jmvcore::Table$new(
options=options,
name="regRICH",
title="Regression Test for Funnel Plot Asymmetry",
rows=1,
columns=list(
list(
`name`="Z",
`type`="number",
`format`="zto"),
list(
`name`="p",
`type`="number",
`format`="zto,pvalue"))))}))$new(options=options))
self$add(jmvcore::Image$new(
options=options,
name="funplot",
title="Funnel Plot",
width=600,
height=450,
renderFun=".funplot",
refs=list(
"metafor")))}))
metaProportionBase <- if (requireNamespace('jmvcore')) R6::R6Class(
"metaProportionBase",
inherit = jmvcore::Analysis,
public = list(
initialize = function(options, data=NULL, datasetId="", analysisId="", revision=0) {
super$initialize(
package = 'MAJOR',
name = 'metaProportion',
version = c(1,0,0),
options = options,
results = metaProportionResults$new(options=options),
data = data,
datasetId = datasetId,
analysisId = analysisId,
revision = revision,
pause = NULL,
completeWhenFilled = FALSE,
requiresMissings = FALSE)
}))
#' Proportions
#'
#'
#' @param data .
#' @param xi .
#' @param ni .
#' @param slab .
#' @param moderatorcor .
#' @param methodmetacor .
#' @param cormeasure .
#' @param moderatorType .
#' @param level .
#' @param showModelFit .
#' @param addcred .
#' @param addfit .
#' @param showweights .
#' @param steps .
#' @param xAxisTitle .
#' @param pchForest .
#' @param forestOrder .
#' @param fsntype .
#' @param yaxis .
#' @param yaxisInv .
#' @param enhanceFunnel .
#' @return A results object containing:
#' \tabular{llllll}{
#' \code{results$textRICH} \tab \tab \tab \tab \tab a table \cr
#' \code{results$tableTauSqaured} \tab \tab \tab \tab \tab a table \cr
#' \code{results$modelFitRICH} \tab \tab \tab \tab \tab a table \cr
#' \code{results$plot} \tab \tab \tab \tab \tab an image \cr
#' \code{results$pubBias$fsnRICH} \tab \tab \tab \tab \tab a table \cr
#' \code{results$pubBias$rankRICH} \tab \tab \tab \tab \tab a table \cr
#' \code{results$pubBias$regRICH} \tab \tab \tab \tab \tab a table \cr
#' \code{results$funplot} \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$textRICH$asDF}
#'
#' \code{as.data.frame(results$textRICH)}
#'
#' @export
metaProportion <- function(
data,
xi,
ni,
slab,
moderatorcor,
methodmetacor = "REML",
cormeasure = "PR",
moderatorType = "NON",
level = 95,
showModelFit = FALSE,
addcred = FALSE,
addfit = TRUE,
showweights = FALSE,
steps = 5,
xAxisTitle,
pchForest = "15",
forestOrder = "fit",
fsntype = "Rosenthal",
yaxis = "sei",
yaxisInv = FALSE,
enhanceFunnel = FALSE) {
if ( ! requireNamespace('jmvcore'))
stop('metaProportion requires jmvcore to be installed (restart may be required)')
if ( ! missing(xi)) xi <- jmvcore::resolveQuo(jmvcore::enquo(xi))
if ( ! missing(ni)) ni <- jmvcore::resolveQuo(jmvcore::enquo(ni))
if ( ! missing(slab)) slab <- jmvcore::resolveQuo(jmvcore::enquo(slab))
if ( ! missing(moderatorcor)) moderatorcor <- jmvcore::resolveQuo(jmvcore::enquo(moderatorcor))
if (missing(data))
data <- jmvcore::marshalData(
parent.frame(),
`if`( ! missing(xi), xi, NULL),
`if`( ! missing(ni), ni, NULL),
`if`( ! missing(slab), slab, NULL),
`if`( ! missing(moderatorcor), moderatorcor, NULL))
options <- metaProportionOptions$new(
xi = xi,
ni = ni,
slab = slab,
moderatorcor = moderatorcor,
methodmetacor = methodmetacor,
cormeasure = cormeasure,
moderatorType = moderatorType,
level = level,
showModelFit = showModelFit,
addcred = addcred,
addfit = addfit,
showweights = showweights,
steps = steps,
xAxisTitle = xAxisTitle,
pchForest = pchForest,
forestOrder = forestOrder,
fsntype = fsntype,
yaxis = yaxis,
yaxisInv = yaxisInv,
enhanceFunnel = enhanceFunnel)
analysis <- metaProportionClass$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.