isValid_scalar: Check validity of g-and-k or g-and-h parameters

View source: R/isValid.R

isValid_scalarR Documentation

Check validity of g-and-k or g-and-h parameters

Description

Check whether parameter choices produce a valid g-and-k or g-and-h distribution.

Usage

isValid_scalar(
  g,
  k_or_h,
  c = 0.8,
  model = c("gk", "generalised_gh", "tukey_gh", "gh"),
  initial_z = seq(-1, 1, 0.2)
)

Arguments

g

A g parameter.

k_or_h

A k or h parameter.

c

A c parameter.

model

Which model to check: "gk", "generalised_gh" or "tukey_gh". For backwards compatibility, "gh" acts the same as "generalised_gh".

initial_z

Vector of initial z values to use in optimisation.

Details

This internal function performs the calculation using scalar parameter inputs. The exported function is a vectorised wrapper of this.

Value

Logical vector denoting whether each parameter combination is valid


gk documentation built on Aug. 10, 2023, 5:06 p.m.

Related to isValid_scalar in gk...