-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
145 lines (107 loc) · 5.25 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
---
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%"
)
```
# gbtransparency <a href="https://special-adventure-gq3r94k.pages.github.io/"><img src="man/figures/logo.png" align="right" height="139" alt="gbtransparency website" /></a>
<!-- badges: start -->
[](https://github.com/Teal-Insights/gbtransparency/actions/workflows/R-CMD-check.yaml)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/Teal-Insights/gbtransparency/actions/workflows/test-coverage.yaml)
[](https://codecov.io/gh/Teal-Insights/gbtransparency)
[](https://choosealicense.com/licenses/cc0-1.0/)
[](https://github.com/Teal-Insights/gbtransparency/actions/workflows/pkgdown.yaml)
<!-- badges: end -->
`gbtransparency` is primarily a data package enabling an efficient method for working with [Green Bond Transparency datasets](https://www.greenbondtransparency.com/support/resources/) in R.
### About the Green Bond Transparency datasets:
The Green Bond Transparency(GBTP) has developed a free and public integrated dataset of all the bond's information included in the platform presented in five export-files. `gbtransparency` helps users to access files. These files are:
(1) `bond's` general information
(2) `allocation` of proceeds to project categories using international standards (GBP, CBI)
(3) `measurements` of impact and outcome KPIs
(4) individual bond-`tranche` information
(5) detailed information of the `projects` receiving disbursements.
There is also an additional file named `index`. This shows description of variable names per data.
### Relevant Notes
1. **`gbtransparency` is still under heavy development**: Please use accordingly. The initial phase of package development aims to finalize stable versions of the datasets, and will be announced with a new package version release and note. Further development will focus on building helper functions to aid efficient analysis workflows with the dataset.
2. **`gbtransparency` is a personal project**: While the package author works as a [consultant to AidData](https://www.linkedin.com/feed/update/urn:li:activity:7067478837885849600/) this package is a personal project. The author built the package for his own own use, but hopes that it can grow into a robust package that can aid researchers, policymakers, and others interested in gaining actionable, empirically-based insights about Green Bond Transparency datasets.
### Installation
You can install the development version of `gbtransparency` from [GitHub](https://github.com/) with:
``` r
# install the `devtools` package if not yet installed
# install.packages("devtools")
# install gbtransparency from GitHub
devtools::install_github("Teal-Insights/gbtransparency")
```
This package will likely never be published on [CRAN](https://cran.r-project.org/) because the data file sizes are too big.
### Using gbtransparency package
The datasets in the packages are as follow:
```{r echo=FALSE, message=FALSE,warning=FALSE}
library(tidyverse)
base::data.frame(
package_data_name = c(
"gbt_allocations",
"gbt_bonds",
"gbt_key_performance_indicators",
"gbt_projects",
"gbt_tranches",
"gbt_data_dictionary"),
website_data_description = c(
"allocation of proceeds to project categories using international standards (GBP, CBI)",
"bond's general information",
"measurements of impact and outcome KPIs",
"detailed information of the projects receiving disbursements",
"individual bond-tranche information",
"index (description of variable names per data.)")
) %>% knitr::kable()
```
```{r}
```
Now we can have a look at the first six observations per data
```{r example}
library(gbtransparency)
```
```{r}
```
#### a) `gbt_allocations`: allocation of proceeds to project categories using international standards (GBP, CBI)
```{r}
utils::head(x = gbt_allocations) %>% knitr::kable()
```
```{r}
```
#### b) `gbt_bonds`: bond’s general information
```{r}
utils::head(x = gbt_bonds) %>% knitr::kable()
```
```{r}
```
#### c) `gbt_key_performance_indicators`: measurements of impact and outcome KPIs
```{r}
utils::head(x = gbt_key_performance_indicators) %>% knitr::kable()
```
```{r}
```
#### d) `gbt_projects`: detailed information of the projects receiving disbursements
```{r}
utils::head(x = gbt_projects) %>% knitr::kable()
```
```{r}
```
#### e) `gbt_tranches`: individual bond-tranche information
```{r}
utils::head(x = gbt_tranches) %>% knitr::kable()
```
```{r}
```
#### f) `gbt_data_dictionary`: index (description of variable names per data.)
```{r}
utils::head(x = gbt_data_dictionary) %>% knitr::kable()
```
```{r}
```