eempf_ssc: Calculate the shift-and shape-sensitive congruence (SSC)...

eempf_sscR Documentation

Calculate the shift-and shape-sensitive congruence (SSC) between model components

Description

The data variable pf_models can be supplied as list of PARAFAC models, output from a splithalf analysis or list of matrices Please see details of calculation in: U.J. Wünsch, R. Bro, C.A. Stedmon, P. Wenig, K.R. Murphy, Emerging patterns in the global distribution of dissolved matter fluorescence, Anal. Methods, 11 (2019), pp. 888-893

Usage

eempf_ssc(
  pfmodels,
  tcc = FALSE,
  m = FALSE,
  cores = parallel::detectCores(logical = FALSE)
)

Arguments

pfmodels

list of either PARAFAC models or component matrices

tcc

if set TRUE, TCC is returned instead

m

logical, if TRUE, emission and excitation SSCs or TCCs are combined by calculating the geometric mean

cores

number of CPU cores to be used

Value

(list of) tables containing SCCs between components

Examples


pf_models <- pf3[1:3]

sscs <- eempf_ssc(pf_models, cores = 2)
sscs

tcc <- eempf_ssc(pf_models, tcc = TRUE, cores = 2)
tcc
## mixed tcc (combine em and ex)
mtcc <- eempf_ssc(pf_models, tcc = TRUE, m = TRUE, cores = 2)
mtcc

## compare results from splithalf analysis
sh_sscs <- eempf_ssc(sh, cores = 2)

sh_sscs
## view diagonals only (components with similar numbers only)
lapply(sh_sscs, lapply, diag)


staRdom documentation built on July 9, 2023, 5:57 p.m.