get.unif.par: Fitting parameters of a uniform distribution from two or more...

Description Usage Arguments Details Value Note Author(s) Examples

View source: R/rriskDistributions_functions.R

Description

get.unif.par returns the parameters of a uniform distribution where the pth percentiles match with the quantiles q.

Usage

1
get.unif.par(p = c(0.025, 0.975), q, plot = TRUE, scaleX = c(0.1, 0.9), ...)

Arguments

p

numeric, single value or vector of probabilities.

q

numeric, single value or vector of quantiles corresponding to p.

plot

logical, if TRUE the graphical diagnostics will be plotted (default value is TRUE)

scaleX

numerical vector of the length 2 containing values (from the open interval (0, 1)) for scaling quantile-axis (relevant only if plot = TRUE). The smaller the left value, the further the graph is extrapolated within the lower percentile, the greater the right value, the further it goes within the upper percentile.

...

further arguments passed to the functions plot and points (relevant only if plot = TRUE)

Details

The number of probabilities and the number of quantiles must be identical and should be at least two. Using the default p, the three corresponding quantiles are the 2.5th percentile, the median and the 97.5th percentile, respectively.

Parameters of the uniform distribution are estimated exactly.

The items of the probability vector p should lie between 0 and 1.

Value

Returns fitted parameters of a uniform distribution.

Note

It should be noted that there might be deviations between the estimated and the theoretical distribution parameters in certain circumstances. This is because the estimation of the parameters is based on a numerical optimization method and depends strongly on the initial values. In addition, one must always keep in mind that a distribution for different combinations of parameters may look very similar. Therefore, the optimization method cannot always find the "right" distribution, but a "similar" one.

If the function terminates with the error massage "convergence error occurred or specified tolerance not achieved", one may try to set the convergence tolerance to a higher value. It is yet to be noted, that good till very good fits of parameters could only be obtained for tolerance values that are smaller than 0.001.

Author(s)

Matthias Greiner matthias.greiner@bfr.bund.de (BfR),
Katharina Schueller schueller@stat-up.de (STAT-UP Statistical Consulting),
Natalia Belgorodski belgorodski@stat-up.de (STAT-UP Statistical Consulting)

Examples

1
2
3
4
5
6
q <- stats::qunif(p = c(0.025, 0.975), min = 0, max = 5)
get.unif.par(q = q)
get.unif.par(q = q, scaleX = c(0.001, 0.999))

q <- stats::qunif(p = c(0.025, 0.975), min=-6, max = 5)
get.unif.par(q = q)

rriskDistributions documentation built on May 19, 2017, 2:36 p.m.

Search within the rriskDistributions package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.