is.valid.PGP_Model: Check if an object is a valid PGP_Model

In Pareto: The Pareto, Piecewise Pareto and Generalized Pareto Distribution

Check if an object is a valid PGP_Model

Description

Checks if an object is a PGP_Model object and whether it is valid for the use in functions like Layer_Mean

Usage

is.valid.PGP_Model(x, comment = FALSE)

Arguments

x	Object to be checked.
comment	If FALSE then the function returns a boolean indicating whether x is a valid PGP_Model. If TRUE then the function returns a comment instead.

Examples

PGPM <- PGP_Model(2, 1000, 1, 2, dispersion = 2)
PGPM
is.valid.PGP_Model(PGPM)
is.valid.PGP_Model(PGPM, comment = TRUE)

PGPM$alpha_tail <- -2
is.valid.PGP_Model(PGPM)
is.valid.PGP_Model(PGPM, comment = TRUE)

Pareto documentation built on April 18, 2023, 9:10 a.m.