-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
117 lines (85 loc) · 4.85 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# wbids
<!-- badges: start -->
[](https://cran.r-project.org/package=wbids)
[](https://cran.r-project.org/package=wbids)
[](https://github.com/Teal-Insights/r-wbids/actions/workflows/R-CMD-check.yaml)
[](https://github.com/Teal-Insights/r-wbids/actions/workflows/lint.yaml)
[](https://app.codecov.io/gh/Teal-Insights/r-wbids)
<!-- badges: end -->
`wbids` is an R package to access and analyze the World Bank’s [International Debt Statistics (IDS)](https://datacatalog.worldbank.org/search/dataset/0038015/). IDS provides creditor-debtor relationships between countries, regions, and institutions. 'wbids' enables users to download, process and work with IDS series across multiple geographies, counterparts, and time periods.
The `wbids` package relies on a redefinition of the original World Bank data: 'geographies' 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.
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 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 geographies 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, geographies, 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_geographies()
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_geographies]
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
```