ffaframework (version 0.1.0)

data_screening: Perform Data Screening

Description

Checks for missing entries and generates a list of summary statistics about a dataset.

Usage

data_screening(data, years)

Value

A list with seven entries:

• years_min: The minimum value in the 'years' argument.

• years_max: The maximum value in the 'years' argument.

• data_min: The minimum value in the 'data' argument.

• data_med: The median value in the 'data' argument.

• data_max: The maximum value in the 'data' argument.

• missing_years: An integer vector of years with no data.

• missing_count: The number of missing entries in the dataset.

Arguments

data

Numeric vector of observed annual maximum series values. Must be strictly positive, finite, and not missing.

years

Numeric vector of observation years corresponding to data. Must be the same length as data and strictly increasing.

Examples

data <- rnorm(n = 10, mean = 100, sd = 10)
years <- c(1900, 1902, 1903, 1904, 1905, 1907, 1909, 1911, 1912, 1914)
data_screening(data, years)