summaryStox: The summary function introduced in StoX <= 2.7.

summaryStoxR Documentation

The summary function introduced in StoX <= 2.7.

Description

The summary function introduced in StoX <= 2.7.

Usage

summaryStox(x, percentages = c(5, 50, 95), na.rm = FALSE)

Arguments

x

numeric vector whose sample quantiles are wanted, or an object of a class for which a method has been defined (see also ‘details’). NA and NaN values are not allowed in numeric vectors unless na.rm is TRUE.

percentages

The percentages to get percentiles for, equivalent to 100 * probs in quantile.

na.rm

logical; if true, any NA and NaN's are removed from x before the quantiles are computed.


StoXProject/RstoxBase documentation built on July 14, 2024, 9:39 a.m.