opnmfR_ranksel_perm: Permutation based rank selection

Description Usage Arguments Value

View source: R/opnmfR.R

Description

Permutation based rank selection

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
opnmfR_ranksel_perm(
  X,
  rs,
  W0 = NULL,
  use.rcpp = TRUE,
  nperm = 1,
  plots = TRUE,
  seed = NA,
  rtrue = NA,
  ...
)

Arguments

X

A matrix, rows are the number of features and columns are number of samples

rs

A vector of ranks to test for selection, if rs=NULL then 1:nrow(X) is used (default NULL)

W0

A string or matrix for initialization (default NULL)

use.rcpp

A logical, use opnmfRcpp() (default TRUE) dimensional data (default TRUE)

nperm

A number, number of permuatations conducted (default 1)

plots

A logical, create a dot plot displaying the similarity measures for ranks provided and indicating the highest value for each measure (default TRUE)

seed

the set.seed used to select the split-half (default NA)

rtrue

the true rank of the input data if known (default NA)

Value

A list containing the approximation matrices W and H, of input matrix X; the interation number at which a solution was found; the reconstruction error, time taken for rank selection; the seed used for permutation of input data matrix #' @examples result <- opnmfR_ranksel_perm()


kaurao/opnmfR documentation built on March 12, 2021, 4:15 a.m.