shrinkageNLMEproject: Determines the shrinkage in percent for each ETA or for WRES
shrinkageNLMEproject.Rd
shrinkageNLMEproject: Determines the shrinkage in percent for each ETA or for WRES
shrinkageNLMEproject(
projectPath,
ETA_THRESHOLD_REL = 0,
stratifyShrinkageBy = NULL,
type = c("eta", "eps")
)
Arguments
- projectPath
path to an NLME project
- ETA_THRESHOLD_REL
ETA values with
abs(ETA) < ETA_THRESHOLD_REL * mean(abs(ETA))
will not be considered for the computation of shrinkage.- stratifyShrinkageBy
character pointing to a categorical covariate column in the dataset. Shrinkage will be reported separately for each level of the covariate.
- type
ETA shrinkage ("eta", default) or EPSILON shrinkage ("eps").
Value
list of length 1 (if stratifyShrinkageBy = NULL) or length of unique levels of the categorical covariate used for stratification. Each element of the list contains the shrinkage values as percentage (0-100).