metrica (version 2.1.0)

TSS: Total Sum of Squares (TSS)

Description

It estimates the TSS for observed vector.

Usage

TSS(data = NULL, obs, tidy = FALSE, na.rm = TRUE)

Value

an object of class numeric within a list (if tidy = FALSE) or within a data frame (if tidy = TRUE).

Arguments

data

(Optional) argument to call an existing data frame containing the data.

obs

Vector with observed values (numeric).

tidy

Logical operator (TRUE/FALSE) to decide the type of return. TRUE returns a data.frame, FALSE returns a list; Default : FALSE.

na.rm

Logic argument to remove rows with missing values (NA). Default is na.rm = TRUE.

Details

The TSS sum of the squared differences between the observations and its mean. It is used as a reference error, for example, to estimate explained variance. For the formula and more details, see online-documentation

Examples

# \donttest{
set.seed(1)
X <- rnorm(n = 100, mean = 0, sd = 10)
Y <- X + rnorm(n=100, mean = 0, sd = 3)
TSS(obs = X)
# }