setNMFSeed: 'NMFSeed' is a constructor method that instantiate 'NMFSeed'...

Description Usage Arguments Methods (by generic)

View source: R/registry-seed.R

Description

NMF seeding methods are registered via the function setNMFSeed, which stores them as NMFSeed objects in a dedicated registry.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
NMFSeed(key, method, ...)

## S4 method for signature 'character'
NMFSeed(key, method, ...)

## S4 method for signature 'NMFSeed'
NMFSeed(key, method, ...)

setNMFSeed(..., overwrite = isLoadingNamespace(), verbose = TRUE)

removeNMFSeed(name, ...)

Arguments

key

access key as a single character string

method

specification of the seeding method, as a function that takes at least the following arguments:

object

uninitialised/empty NMF model, i.e. that it has 0 rows and columns, but has already the rank requested in the call to nmf or seed.

x

target matrix

...

extra arguments

...

arguments passed to NMFSeed and used to initialise slots in the NMFSeed object, or to pkgreg_remove.

overwrite

logical that indicates if any existing NMF method with the same name should be overwritten (TRUE) or not (FALSE), in which case an error is thrown.

verbose

a logical that indicates if information about the registration should be printed (TRUE) or not (FALSE).

name

name of the seeding method.

Methods (by generic)


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