get_pcp_defaults: Retrieves the default Root PCP parameter settings for a given...

View source: R/get_pcp_defaults.R

get_pcp_defaultsR Documentation

Retrieves the default Root PCP parameter settings for a given matrix.

Description

get_pcp_defaults retrieves the default Root PCP lambda and mu parameter settings for a given matrix.

Usage

get_pcp_defaults(mat)

Arguments

mat

The matrix for which the default lambda and mu are needed.

Value

A list containing the default lambda and mu values used in most PCP functions, and the default eta value used in RRMC. labelled as "lambda", "mu", and "eta" respectively.

Examples


# simulate a data matrix:

n <- 50
p <- 10
data <- sim_data(sim_seed = 1, nrow = n, ncol = p, rank = 3, sigma=0, add_sparse = FALSE)
mat <- data$M

# get the default PCP parameters:
default <- get_pcp_defaults(mat)
default_lambda <- default$lambda
default_mu <- default$mu

Columbia-PRIME/PCPhelpers documentation built on April 24, 2022, 7:57 p.m.