lnorm_HD {bayespm} | R Documentation |
The Highest Density (HD) interval of Lognormal distribution.
Description
lnorm_HD is used to derive the narrowest interval of a predetermined coverage from a Lognormal distribution, containing the Highest Density (HD) values.
Usage
lnorm_HD( cover = NULL, mulog = NULL, sdlog = NULL, plot = FALSE,
xlab = "x", ylab = "Density" )
Arguments
cover |
scalar (between 0 and 1); The coverage (probability) of the Highest Density (HD). |
mulog |
scalar (real); It is the scale parameter of the Lognormal distribution and needs to be a number. |
sdlog |
scalar (positive); It is the shape parameter of the Lognormal distribution and needs to be a number. |
plot |
logical; if TRUE, the plot of the HD region is displayed. It is FALSE by default. |
xlab , ylab |
The titles of the x-axis and y-axis for the HD plot. The default values are "x" and "Density". |
Details
lnorm_HD provides the Highest Density (HD) of a Lognormal distribution. HD is the narrowest interval with a pretermined coverage. The values included in HD have density larger than every point outside the region.
Value
Returns a data frame with the upper and the lower limits of the Highest Predictive Denisty or Mass (HPrD/M) region, the lower and the achieved coverage. If plot=T, then the HPrD/M is visualized.
Examples
lnorm_HD(0.95, 0, 1/2, plot = TRUE)