binteg: bivariate integration

Description Usage Arguments Details Value Author(s) References Examples


An efficient approach for bivariate integration.





are marginal probabilities (ARIs/AEPs) of X forcing variable associated with rows of z (e.g. rainfall).


are marginal probabilities (ARIs/AEPs) of Y forcing variable associated with columns of z (e.g. storm tides).


is a table of response variable values (e.g., flood levels) for each (x,y) combination.


is the parameter for the model being used.


are probabilities (ARIs/AEPs) for which output response variable levels are desired


is the model used, either logistic model ("log", default) or negative logsitic model ("neglog").


is the manner in which probabilities are specified, either ARI (annual recurrence interval) or annual exceed probability (AEP). See Details


is the number of response variable contours to be considered across the range of z table.


is the number of integration increments for each piecewise section of response variable contour lines.


This package is illustrated for the example of coastal flood levels (the response variable) forced by extreme rainfall (x) and extreme storm tides (y). For this problem, the low bounds of the marginal distributions, i.e. no rainfall (x) and a suitable tide level (such as mean sea level or the lowest astronomical tide) are denoted as ARI=0/AEP=1. "binteg" estimates the flood risk allows for joint dependence between the extreme values of two forcing variables (rainfall and storm tides). Here the logistic and negative logistic model are used to model dependence due to their simplicity and great ability (see Zheng et al. 2014a). The results from "binteg" also include estimates for the cases of complete dependence (alpha=0) and independence (alpha=1) to enable a comparison with the observed dependence strength.

An issue in the use of the proposed integral method is when the response variable table (e.g.flood level table) does not encapsulate the entirety of the boundary function. This can be seen from the example of this package whenever a flood contour intersects the upper or right-hand bound (as with contours 1.8m and higher that intersect the upper bound of the figure). In order to address this issue, return probabilities of two alternate cases are computed. Taking the h=2 m in (use "plot2" to generate the figure) for illustration, the first case is to project the red contour line (h=2 m) horizontally back to the y axis at the storm tide intersection ARI=500. This caps the largest storm tide at ARI=500, which will result in an overestimate of the return probability. The second case is to extend the red contour line (h=2 m) vertically to infinity, i.e., assuming the largest flood level produced by the storm tides is h=2 m, even if the storm tide ARI tends to infinity . For this case, the return probability is underestimated. Using this approach, the two cases which give over and under estimates are respectively shown different flood levels (see the figure provided by "plot2"). For the given ARIs/AEPs, if the differences of the flood levels from the two cases are insignificant, the provided response variable table is sufficient for estimation. Otherwise a more extended table with larger marginal ARIs/AEPs is required.


Returns a list of results


are the AEPs that are onsidered


are the ARIs that are considered


are response variable estimates using the observed dependence, complete dependence and independence, see Details


are given ARIs/AEPs of X variable associated with rows (reproduced from inputs).


are given ARIs/AEPs of Y variable associated with columns (reproduced from inputs).


is the given table of response variable values (reproduced from inputs).


is the given parameter (reproduced from inputs).


is the specified model, either logistic model (default) or negative logsitic model (reproduced from inputs).


is the specified format of probablity, ARI or AEP (reproduced from inputs).


Feifei Zheng, Michael Leonard, Seth Westra


Zheng, F., S. Westra, and S. A. Sisson (2013), Quantifying the dependence between extreme rainfall and storm surge in the coastal zone, Journal of Hydrology, 505(0), 172-187.

Zheng, F., Westra S. Sisson S. and Leonard M. (2014a). Modelling the dependence between extreme rainfall and storm surge to estimate coastal flood risk, Water Resources Research, under review.

Zheng, F., Leonard M. and Westra S. (2014b). An efficient bivariate integration method for joint probability analysis of flood risk, Water Resources Research, under review.



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

Questions? Problems? Suggestions? or email at

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

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