checkIterArgs: Used to inherit roxygen docs

In nfultz/stats.extra: Highest Density Regions and Other Functions of Distributions

Description

Used to inherit roxygen docs

Usage

checkIterArgs(gradtol, steptol, iterlim)

Arguments

gradtol	Parameter for the nlm optimisation - a positive scalar giving the tolerance at which the scaled gradient is considered close enough to zero to terminate the algorithm (see [nlm doccumentation](https://stat.ethz.ch/R-manual/R-patched/library/stats/html/nlm.html)).
steptol	Parameter for the nlm optimisation - a positive scalar providing the minimum allowable relative step length (see [nlm doccumentation](https://stat.ethz.ch/R-manual/R-patched/library/stats/html/nlm.html)).
iterlim	Parameter for the nlm optimisation - a positive integer specifying the maximum number of iterations to be performed before the program is terminated (see [nlm doccumentation](https://stat.ethz.ch/R-manual/R-patched/library/stats/html/nlm.html)).

nfultz/stats.extra documentation built on Oct. 15, 2020, 8:28 p.m.