Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/athammad/pbox
pbox R package. Exploring multivariate spaces with Probability Boxes
https://github.com/athammad/pbox
climate-change copula environmental-monitoring financial-analysis probability r risk-assessment risk-management statistics
Last synced: 3 months ago
JSON representation
pbox R package. Exploring multivariate spaces with Probability Boxes
- Host: GitHub
- URL: https://github.com/athammad/pbox
- Owner: athammad
- License: gpl-3.0
- Created: 2024-04-03T03:34:57.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-09T10:39:18.000Z (7 months ago)
- Last Synced: 2024-10-01T16:36:40.544Z (4 months ago)
- Topics: climate-change, copula, environmental-monitoring, financial-analysis, probability, r, risk-assessment, risk-management, statistics
- Language: R
- Homepage:
- Size: 1.78 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PBOX 
[](https://cran.r-project.org/web/packages/pbox/)
[](https://cran.rstudio.com/package=pbox)
### Version 0.1.8
## Overview
The [pbox](https://github.com/athammad/pbox) R package is designed for risk assessment and management. It is an advanced statistical library that excels in exploring probability distributions within a given dataset. The tool offers a method to encapsulate and query the probability space effortlessly. Its distinctive feature lies in the ease with which users can navigate and analyze marginal, joint, and conditional probabilities while taking into account the underlying correlation structure inherent in the data. This unique capability empowers users to delve into intricate relationships and dependencies within a dataset, providing a solid foundation for making well-informed decisions in the context of risk management scenarios. With `pbox` is straightforward to answer questions like:
- What is the probability of experiencing extreme heat waves in Indonesia with temperatures above 32 degrees?
- What is the probability of simultaneous extreme heat waves in Vietnam with temperatures above than 31 degrees and the average regional temperature being above than 26 degrees?
- Given that the average regional temperature is 26 degrees, what is the probability of experiencing extreme heat waves in both Vietnam and Indonesia with temperatures above 33 degrees?
## Features
**Generate a `pbox` object from data**
```{r, echo=TRUE, eval=FALSE}
data("SEAex")
pbx<-set_pbox(SEAex)
pbx
```
**Access the data and the copula object**
```{r, echo=TRUE, eval=FALSE}
pbx@data
pbc@copula
```
**Access the results of the automated selection for both the marginal distribution and the copula**
```{r, echo=TRUE, eval=FALSE}
pbx@fit
```
**Explore the probabilistic space**
```{r, echo=TRUE, eval=FALSE}
#Get marginal distribution
qpbox(pbx,mj = "Malaysia:33")
#Get Joint distribution
qpbox(pbx,mj = "Malaysia:33 & Vietnam:34")
# Conditional distribution distribution with Pr(X <= x, Y <= y) / Pr(Y = y)
qpbox(pbx,mj = "Malaysia:33 & median:c(Vietnam,Thailand)", co="mean:c(avgRegion)", fixed=TRUE)
# Estimate confidence intervals
qpbox(pbx,mj = "Vietnam:31 & avgRegion:26", co="Malaysia:32",CI=T)
```
**Map the probabilistic space with a gird of quantile values**
```{r, echo=TRUE, eval=FALSE}
grid_pbox(pbx, mj = c("Vietnam", "Malaysia"))
```
**Query the probabilistic space under different scenarios with different combinations of parameters for a single query**
```{r, echo=TRUE, eval=FALSE}
scenario_pbox(pbx,mj = "Vietnam:31 & avgRegion:26", param_list = list(Vietnam="mu"))
```
## Installation
The `pbox` package is currently under active development. The development version can be installed from GitHub,the stable version can be install directly from CRAN. Below are the installation instructions for both the development version and the CRAN version:
### Development Version
To install the development version from GitHub, you first need to install the remotes package if you haven't already. Then, use `remotes::install_github` to install the `pbox` package from GitHub:
```
install.packages("remotes")
remotes::install_github("athammad/pbox")
```
### CRAN Version
Install `pbox` directly from CRAN with the following command:
```
install.packages("pbox")
```
## Getting Help or Reporting an Issue
To report bugs/issues/feature requests, please file an [issue](https://github.com/athammad/pbox/issues/).
## Author
`pbox` is written by [Ahmed T. Hammad](https://athsas.com/) and is under active development. Please feel free to contribute by submitting any issues or requests—or by solving any current issues!