getArgumentExclusions: Arguments to be excluded from the specification

In latrend: A Framework for Clustering Longitudinal Data

Arguments to be excluded from the specification

Description

Returns the names of arguments that should be excluded during instantiation of the specification.

Usage

getArgumentExclusions(object, ...)

## S4 method for signature 'lcMethod'
getArgumentExclusions(object)

Arguments

object	The object.
...	Not used.

Value

A ⁠character vector⁠ of argument names.

Implementation

This function only needs to be implemented if you want to avoid users from specifying redundant arguments or arguments that are set automatically or conditionally on other arguments.

setMethod("getArgumentExclusions", "lcMethodExample", function(object) {
  c(
    "doPlot",
    "verbose",
    callNextMethod()
  )
})

Adding `callNextMethod()` to the end of the return vector enables inheriting exclusions from superclasses.

See Also

getArgumentDefaults

lcMethod getArgumentExclusions

Other lcMethod implementations: getArgumentDefaults(), lcMethod-class, lcMethodAkmedoids, lcMethodCrimCV, lcMethodDtwclust, lcMethodFeature, lcMethodFunFEM, lcMethodFunction, lcMethodGCKM, lcMethodKML, lcMethodLMKM, lcMethodLcmmGBTM, lcMethodLcmmGMM, lcMethodMclustLLPA, lcMethodMixAK_GLMM, lcMethodMixtoolsGMM, lcMethodMixtoolsNPRM, lcMethodRandom, lcMethodStratify

latrend documentation built on May 29, 2024, 8:51 a.m.