R/mfBiclust.R

In jonalim/mfBiclust: Pipelines for Bi-Clustering Using Matrix Factorization

#' Matrix-factorization biclustering toolbox
#'
#' Biclustering using PCA and non-negative matrix factorization
#'
#' This package contains functions and classes for creating and analyzing
#' biclustering pipelines. Currently ALS, SVD, NIPALS, SNMF, Spectral, and
#' Plaid are supported.
#'
#' @section Functions:
#'   \code{\link{biclusterGUI}}
#'   \code{\link{BiclusterExperiment-class}}
#'   \code{\link{addStrat}}
#'   \code{\link{BiclusterStrategy-class}}
#'
#' @author Quan Gu, <quan.gu@@glasgow.ac.uk>
#'   Maintainer: Jonathan Lim, <jlim7@@comcast.net>
#'
#' @docType package
#' @name mfBiclust
#'
#' @references \href{https://doi.org/10.1016/j.ymeth.2018.02.004}{Bi-clustering
#'   of metabolic data using matrix factorization tools}
NULL

#' @importFrom methods setClass setAs setGeneric setMethod setValidity
NULL