getDistributionSummary {windAC}

Summary statistics from the fitted distribution

Description

Summary statistics are calculated for the distribution with parameter estimates. Right now only the median is produced.

Usage

getDistributionSummary(distribution, paramVec, truncBounds = NULL, ...)

Arguments

distribution

String indicating which distribution to use.

paramVec

Numeric vector for the parameters associated with distribution. Assumed to be in the same order as the function indicated by distribution.

truncBounds

Numeric, indicating bounds for the area correction calculation, see details. Default is NULL, and the bounds are set to c(0,Inf).

...

Additional arguments to integrate.

Details

The truncBounds argument defaults to zero as a lower bound and infinity as the upper bound. If a single value is provided, it is assumed as the upper bound with zero as the lower bound. If two or more values are provided, the max(truncBounds) is the upper bound and min(truncBounds) is the lower bound.

Value

Data frame with the summary statistics.

Examples

getDistributionSummary('norm',c(40,25),truncBounds=c(-Inf,Inf))

getDistributionSummary('norm',c(40,25),truncBounds=NULL)

getDistributionSummary('norm',c(40,25),truncBounds=c(0,30))