NMFList-class: Class for Storing Heterogeneous NMF fits

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

Description

This class wraps a list of NMF fit objects, which may come from different runs of the function nmf, using different parameters, methods, etc.. These can be either from a single run (NMFfit) or multiple runs (NMFfitX).

Note that its definition/interface is very likely to change in the future.

Usage

## S4 method for signature 'NMFList'
show(object)

## S4 method for signature 'NMFList'
algorithm(object, string = FALSE, unique = TRUE)

## S4 method for signature 'NMFList'
seqtime(object)

## S4 method for signature 'NMFList'
runtime(object, all = FALSE)

Arguments

object	an object of class NMFList
string	a logical that indicate whether the names should be collapsed into a comma-separated string.
unique	a logical that indicates whether the result should contain the set of method names, removing duplicated names. This argument is forced to TRUE when string=TRUE.
all	logical that indicates if the CPU time of each fit should be returned (TRUE) or only the total CPU time used to compute all the fits in object.

Methods (by generic)

• show(object = NMFList): Show method for objects of class NMFList

• algorithm(object = NMFList): Returns the method names used to compute the NMF fits in the list. It returns NULL if the list is empty.

• seqtime(object = NMFList): Returns the CPU time that would be required to sequentially compute all NMF fits stored in object.

  This method calls the function runtime on each fit and sum up the results. It returns NULL on an empty object.

• runtime(object = NMFList): Returns the CPU time required to compute all NMF fits in the list. It returns NULL if the list is empty. If no timing data are available, the sequential time is returned.

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