r-wbids

R package to access and analyze World Bank International Debt Statistics (IDS)

https://github.com/teal-insights/r-wbids

Repository

R package to access and analyze World Bank International Debt Statistics (IDS)

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# wbids


[![CRAN status](https://www.r-pkg.org/badges/version/wbids)](https://cran.r-project.org/package=wbids)
[![CRAN downloads](https://cranlogs.r-pkg.org/badges/wbids)](https://cran.r-project.org/package=wbids)
[![R-CMD-check](https://github.com/Teal-Insights/r-wbids/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Teal-Insights/r-wbids/actions/workflows/R-CMD-check.yaml)
[![Lint](https://github.com/Teal-Insights/r-wbids/actions/workflows/lint.yaml/badge.svg)](https://github.com/Teal-Insights/r-wbids/actions/workflows/lint.yaml)
[![Codecov test coverage](https://codecov.io/gh/Teal-Insights/r-wbids/graph/badge.svg)](https://app.codecov.io/gh/Teal-Insights/r-wbids)


`wbids` is an R package to access and analyze the World Bank’s [International Debt Statistics (IDS)](https://www.worldbank.org/en/programs/debt-statistics/ids). IDS provides creditor-debtor relationships between countries, regions, and institutions. 'wbids' enables users to download, process and work with IDS series across multiple entities, counterparts, and time periods. 

The `wbids` package relies on a redefinition of the original World Bank data: 'entities' contain both countries and regions, while 'counterparts' include both counterpart areas and institutions. `wbids` provides a consistent mapping of identifiers and names across these different types. The corresponding [package vignette](https://teal-insights.github.io/r-wbids/articles/data-model.html) provides more details on the data model.

The package is part of the [EconDataverse](https://www.econdataverse.org/) family of packages aimed at helping economists and financial professionals work with sovereign-level economic data.

This package is a product of Teal Insights and not sponsored by or affiliated with the World Bank in any way, except for the use of the World Bank IDS API.

## Installation 

You can install `wbids` from [CRAN](https://CRAN.R-project.org/package=wbids) via:

```r
install.packages("wbids")
```

You can also install the development version of `wbids` like this:

```r
# install.packages("pak")
pak::pak("teal-insights/r-wbids")
```

On Linux, you may need to install `libcurl4-openssl-dev` as a prerequisite to build the package.

## Usage

The main function `ids_get()` provides an interface to download multiple IDS series for multiple entities and counterparts and specific date ranges. 

```r
library(wbids)

ids_get(
  geographies = c("ZMB", "ZAF"),
  series = c("DT.DOD.DPPG.CD", "BM.GSR.TOTL.CD"),
  counterparts = c("216", "231"),
  start_year = 2015,
  end_year = 2020
)
```

The package comes with prepared metadata about available series, entities, counterparts, and topics. Please consult the [package vignette](https://teal-insights.github.io/r-wbids/articles/data-model.html) for details. 

```r
ids_list_series()
ids_list_entities()
ids_list_counterparts()
ids_list_series_topics()
```

This data can be used to enrich the IDS series or facilitate data discovery. For further applications, please consult [Teal Insights’ Guide to Working with the World Bank International Debt Statistics](https://teal-insights.github.io/teal-insights-guide-to-wbids/).

The interface and column names are fully consistent with World Development Indicators (WDI) data provided through the `wbwdi` package. You can find details on [github.com/tidy-intelligence/r-wbwdi](https://github.com/tidy-intelligence/r-wbwdi).

## Contributing

Contributions to `wbids` are welcome! If you'd like to contribute, please follow these steps:

1. **Create an issue**: Before making changes, create an issue describing the bug or feature you're addressing.
2. **Fork the repository**: Fork the repository to your GitHub account.
3. **Create a branch**: Create a branch for your changes with a descriptive name.
4. **Make your changes**: Implement your bug fix or feature.
5. **Test your changes**: Run tests to ensure your changes don't break existing functionality.
6. **Submit a pull request**: Push your changes to your fork and submit a pull request to the main repository.

For more detailed information on the package structure and development process, please visit the [project Wiki](https://github.com/Teal-Insights/r-wbids/wiki).

### Package Structure

The package is organized around three main functional groups:

```mermaid
graph TB
    A[wbids] --> B[ids_list_*]
    A --> C[ids_get]
    A --> D[ids_bulk*]
    
    B --> B1[ids_list_counterparts]
    B --> B2[ids_list_entities] 
    B --> B3[ids_list_series]
    B --> B4[ids_list_series_topics]
    
    D --> D1[ids_bulk]
    D --> D2[ids_bulk_files]
    D --> D3[ids_bulk_series]

    classDef default fill:#fff,stroke:#333,color:#333
    classDef main fill:#f9f,stroke:#333,color:#000,font-weight:bold
    classDef group fill:#bbf,stroke:#333,color:#000

    class A main
    class B,C,D group
    class B1,B2,B3,B4,D1,D2,D3 default
```

Owner

GitHub Events

Issues and Pull Requests

Last synced: 10 months ago

Packages