terms: Fixed Terms in NMF Models

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

Description

Formula-based NMF models may contain fixed basis and/or coefficient terms. The functions documented here provide access to these data, which are read-only and defined when the model object is instantiated (e.g., see nmfModel,formula-method).

ibterms, icterms and iterms respectively return the indexes of the fixed basis terms, the fixed coefficient terms and all fixed terms, within the basis and/or coefficient matrix of an NMF model.

Usage

ibterms(object, ...)

icterms(object, ...)

iterms(object, ...)

nterms(object)

nbterms(object)

ncterms(object)

bterms(object)

cterms(object)

ibasis(object, ...)

icoef(object, ...)

Arguments

object	NMF object
...	extra parameters to allow extension (currently not used)

Methods (by generic)

ibterms:

• ibterms(object = NMF): Default pure virtual method that ensure a method is defined for concrete NMF model classes.

• ibterms(object = NMFstd): Method for standard NMF models, which returns the integer vector that is stored in slot ibterms when a formula-based NMF model is instantiated.

• ibterms(object = NMFfit): Method for single NMF fit objects, which returns the indexes of fixed basis terms from the fitted model.

• ibterms(object = NMFfitX): Method for multiple NMF fit objects, which returns the indexes of fixed basis terms from the best fitted model.

icterms:

• icterms(object = NMF): Default pure virtual method that ensure a method is defined for concrete NMF model classes.

• icterms(object = NMFstd): Method for standard NMF models, which returns the integer vector that is stored in slot icterms when a formula-based NMF model is instantiated.

• icterms(object = NMFfit): Method for single NMF fit objects, which returns the indexes of fixed coefficient terms from the fitted model.

• icterms(object = NMFfit): Method for multiple NMF fit objects, which returns the indexes of fixed coefficient terms from the best fitted model.

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