nmfFormals: Showing Arguments of NMF Algorithms

In renozao/NMF: Algorithms and Framework for Nonnegative Matrix Factorization (NMF)

Description

This function returns the extra arguments that can be passed to a given NMF algorithm in a call to nmf().

Usage

nmfFormals(x, ...)

## S3 method for class 'character'
nmfFormals(x, ...)

nmfArgs(x)

Arguments

x	algorithm specification
...	extra argument to allow extension and passed to a suitable method.

Methods (by generic)

• nmfFormals(NMFStrategy): Returns the extra arguments that can be passed to an algorithm encapsulated in an NMFStrategy object.

  Arguments that have default values defined by the strategy are set accordingly.

• nmfFormals(NMFStrategyIterative): Returns the extra arguments that can be passed to the algorithm that is composed by an NMFStrategyIterative object.

  These are the union of the formal arguments of all the functional steps in the algorithm: onInit, Update, Stop, onReturn.

• nmfFormals(character): Returns the extra arguments corresponfing to the NMF algorithm specified by its name (a single string). It is a shorcut for nmfFormals(nmfAlgorithm(x), ...)

See Also

nmfWrapper

Examples

# show arguments of an NMF algorithm
nmfArgs('brunet')
nmfArgs('snmf/r')

renozao/NMF documentation built on June 14, 2020, 9:35 p.m.