uSD: Uncorrected Standard Deviation

View source: R/reg_uSD.R

uSDR Documentation

Uncorrected Standard Deviation

Description

It estimates the (uSD) of observed or predicted values.

Usage

uSD(data = NULL, x, tidy = FALSE, na.rm = TRUE)

Arguments

data

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

x

Vector with numeric observed or predicted values.

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 uSD is the sample, uncorrected standard deviation. The square root of the mean of sum of squared differences between vector values with respect to their mean. It is uncorrected because it is divided by the sample size (n), not n-1. For the formula and more details, see online-documentation

Value

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

Examples


set.seed(1)
X <- rnorm(n = 100, mean = 0, sd = 10)
uSD(x = X)


metrica documentation built on June 30, 2024, 5:07 p.m.