Learn R Programming

⚠️There's a newer version (0.28) of this package.Take me there.

Background

Nonnegative Matrix Factorization (NMF) is an unsupervised learning technique that has been applied successfully in several fields, including signal processing, face recognition and text mining. Recent applications of NMF in bioinformatics have demonstrated its ability to extract meaningful information from high-dimensional data such as gene expression microarrays. Developments in NMF theory and applications have resulted in a variety of algorithms and methods. However, most NMF implementations have been on commercial platforms, while those that are freely available typically require programming skills. This limits their use by the wider research community.

Results

Our objective is to provide the bioinformatics community with an open-source, easy-to-use and unified interface to standard NMF algorithms, as well as with a simple framework to help implement and test new NMF methods. For that purpose, we have developed a package for the R/BioConductor platform. The package ports public code to R, and is structured to enable users to easily modify and/or add algorithms. It includes a number of published NMF algorithms and initialization methods and facilitates the combination of these to produce new NMF strategies. Commonly used benchmark data and visualization methods are provided to help in the comparison and interpretation of the results.

Conclusions

The NMF package helps realize the potential of Nonnegative Matrix Factorization, especially in bioinformatics, providing easy access to methods that have already yielded new insights in many applications.


Travis check:

Copy Link

Version

Install

install.packages('NMF')

Monthly Downloads

8,611

Version

0.22.0

License

GPL (>= 2)

Maintainer

Nicolas Sauwen

Last Published

February 12th, 2020

Functions in NMF (0.22.0)

NMFSeed-class

Base class that defines the interface for NMF seeding methods.
NMFStrategyFunction-class

Interface for Single Function NMF Strategies
advanced-NMF

Advanced Usage of the Package NMF
basisnames

Dimension names for NMF objects
.fcnnls

Internal Routine for Fast Combinatorial Nonnegative Least-Squares
checkErrors

Error Checks in NMF Runs
deviance

Distances and Objective Functions
cluster_mat

Cluster Matrix Rows in Annotated Heatmaps
NMF-deprecated

Deprecated Functions in the Package NMF
nmfApply

Apply Function for NMF Objects
nmfAlgorithm

Listing and Retrieving NMF Algorithms
nmfSeed

Seeding Strategies for NMF Algorithms
Strategy-class

Generic Strategy Class
NMFList-class

Class for Storing Heterogeneous NMF fits
nmfWrapper

Wrapping NMF Algorithms
esGolub

Golub ExpressionSet
NMF-package

Algorithms and framework for Nonnegative Matrix Factorization (NMF).
NMFOffset-class

NMF Model - Nonnegative Matrix Factorization with Offset
NMFfitX-class

Virtual Class to Handle Results from Multiple Runs of NMF Algorithms
NMFfitX1-class

Structure for Storing the Best Fit Amongst Multiple NMF Runs
algorithmic-NMF

Generic Interface for Algorithms
NMFfitX

Factory Method for Multiple NMF Run Objects
connectivity

Clustering Connectivity and Consensus Matrices
summary

Assessing and Comparing NMF Models
NMFfitXn-class

Structure for Storing All Fits from Multiple NMF Runs
c,NMF-method

Concatenating NMF Models
canFit

Testing Compatibility of Algorithm and Models
nmfCheck

Checking NMF Algorithm
heatmap-NMF

Heatmaps of NMF Factors
consensus,NMFfitX1-method

Returns the consensus matrix computed while performing all NMF runs, amongst which object was selected as the best fit.
nmfEstimateRank

Estimate Rank for NMF Models
predict

Clustering and Prediction
pmax.inplace

Updating Objects In Place
.atrack

Annotation Tracks
nneg

Transforming from Mixed-sign to Nonnegative Data
nmf_update.ns

NMF Multiplicative Update for Nonsmooth Nonnegative Matrix Factorization (nsNMF).
nmf_update.lee_R

NMF Algorithm/Updates for Frobenius Norm
nmf_update.brunet_R

NMF Algorithm/Updates for Kullback-Leibler Divergence
methods-NMF

Registry for NMF Algorithms
ccBreaks

Generate Break Intervals from Numeric Variables
profplot

Plotting Expression Profiles
basis

Accessing NMF Factors
parse_formula

Simple Parsing of Formula
ccPalette

Builds a Color Palette from Compact Color Specification
plot,NMFfit,missing-method

Plots the residual track computed at regular interval during the fit of the NMF model x.
NMFStrategyIterative-class

Interface for Algorithms: Implementation for Iterative NMF Algorithms
runtime,NMFList-method

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.
smoothing

Smoothing Matrix in Nonsmooth NMF Models
is.nmf

Testing NMF Objects
silhouette.NMF

Silhouette of NMF Clustering
cophcor

Cophenetic Correlation Coefficient
residuals

Residuals in NMF Models
runtime.all,NMFfitXn-method

Returns the CPU time used to perform all the NMF fits stored in object.
NMFfit-class

Base Class for to store Nonnegative Matrix Factorisation results
fcnnls

Fast Combinatorial Nonnegative Least-Square
show,NMF-method

Show method for objects of class NMF
aheatmap

Annotated Heatmaps
show,NMFList-method

Show method for objects of class NMFList
show,NMFSeed-method

Show method for objects of class NMFSeed
cutdendro

Fade Out the Upper Branches from a Dendrogram
fit

Extracting Fitted Models
show,NMFOffset-method

Show method for objects of class NMFOffset
match_atrack

Extending Annotation Vectors
algorithm,NMFList-method

Returns the method names used to compute the NMF fits in the list. It returns NULL if the list is empty.
bioc-NMF

Specific NMF Layer for Bioconductor
sparseness

Sparseness
consensushc

Hierarchical Clustering of a Consensus Matrix
txtProgressBar

Simple Progress Bar
consensus,NMFfitXn-method

Computes the consensus matrix of the set of fits stored in object, as the mean connectivity matrix across runs.
fitted

Fitted Matrix in NMF Models
basiscor

Correlations in NMF Models
staticVar

Get/Set a Static Variable in NMF Algorithms
registerDoBackend

Utilities and Extensions for Foreach Loops
nmfReport

Run NMF Methods and Generate a Report
nmf_update.euclidean_offset.h

NMF Multiplicative Update for NMF with Offset Models
compare-NMF

Comparing Results from Different NMF Runs
nmfObject

Updating NMF Objects
nmf_update.KL.h

NMF Multiplicative Updates for Kullback-Leibler Divergence
nmf_update.euclidean.h

NMF Multiplicative Updates for Euclidean Distance
offset,NMFfit-method

Returns the offset from the fitted model.
nmf

Running NMF algorithms
NMF-class

Generic Interface for Nonnegative Matrix Factorisation Models
rmatrix

Generating Random Matrices
NMFns-class

NMF Model - Nonsmooth Nonnegative Matrix Factorization
options-NMF

NMF Package Specific Options
NMFstd-class

NMF Model - Standard model
revPalette

Flags a Color Palette Specification for Reversion
nmfAlgorithm.SNMF_R

NMF Algorithm - Sparse NMF via Alternating NNLS
ibterms

Fixed Terms in NMF Models
NMF-defunct

Defunct Functions and Classes in the NMF Package
scale.NMF

Rescaling NMF Models
bterms<-

Fixed Terms in NMF Models
parallel-NMF

Utilities for Parallel Computations
nmf.equal

Testing Equality of NMF Models
getRNG1

Extracting RNG Data from NMF Objects
ccRamp

Builds a Color Ramp from Compact Color Specification
syntheticNMF

Simulating Datasets
purity

Purity and Entropy of a Clustering
show,NMFfitX1-method

Show method for objects of class NMFfitX1
featureScore

Feature Selection in NMF Models
show,NMFfitX-method

Show method for objects of class NMFfitX
ccSpec

Extract Colour Palette Specification
t.NMF

Transformation NMF Model Objects
nmf_update.lsnmf

Multiplicative Updates for LS-NMF
nbasis

Dimension of NMF Objects
tryViewport

Internal Grid Extension
randomize

Randomizing Data
nmfFormals

Showing Arguments of NMF Algorithms
lverbose

Internal verbosity option
setNMFMethod

Registering NMF Algorithms
dispersion

Dispersion of a Matrix
gfile

Open a File Graphic Device
seed

Interface for NMF Seeding Methods
NMFStop

Stopping Criteria for NMF Iterative Strategies
show,NMFfit-method

Show method for objects of class NMFfit
show,NMFStrategyIterative-method

Show method for objects of class NMFStrategyIterative
nmfModel

Factory Methods NMF Models
objective,NMFfit-method

Returns the objective function associated with the algorithm that computed the fitted NMF model object, or the objective value with respect to a given target matrix y if it is supplied.
[,NMF-method

Sub-setting NMF Objects
offset,NMFOffset-method

Offsets in NMF Models with Offset
rss

Residual Sum of Squares and Explained Variance
rnmf

Generating Random NMF Models
NMFSeed

utils-NMF

Utility Function in the NMF Package
setupBackend

Computational Setup Functions
show,NMFfitXn-method

Show method for objects of class NMFfitXn
show,NMFns-method

Show method for objects of class NMFns
NMFStrategy-class

Virtual Interface for NMF Algorithms
NMFStrategy

Factory Method for NMFStrategy Objects