-
Notifications
You must be signed in to change notification settings - Fork 6
/
README.Rmd
199 lines (134 loc) · 10.8 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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
---
output: github_document
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/"
)
```
# getTBinR: Access and Summarise World Health Organization Tuberculosis Data <img src="man/figures/logo.png" align="right" alt="" width="120" />
[](https://mybinder.org/v2/gh/seabbs/getTBinR/master?urlpath=rstudio)
[](https://CRAN.R-project.org/package=getTBinR)
[](https://github.com/seabbs/getTBinR)
[](https://zenodo.org/badge/latestdoi/112591837)
[](https://doi.org/10.21105/joss.01260)
[](https://cran.r-project.org/package=getTBinR)
[](https://cran.r-project.org/package=getTBinR)
Quickly and easily import analysis ready Tuberculosis (TB) burden data, from the World Health Organization (WHO), into R. The aim of `getTBinR` is to allow researchers, and other interested individuals, to quickly and easily gain access to a detailed TB data set and to start using it to derive key insights. It provides a consistent set of tools that can be used to rapidly evaluate hypotheses on a widely used data set before they are explored further using more complex methods or more detailed data. These tools include: generic plotting and mapping functions; a data dictionary search tool; an interactive shiny dashboard; and an automated, country level, TB report. For newer R users, this package reduces the barrier to entry by handling data import, munging, and visualisation. All plotting and mapping functions are built with `ggplot2` so can be readily extended. See [here](http://www.who.int/about/copyright/en/) for the WHO data permissions. For help getting started see the [Getting Started](https://www.samabbott.co.uk/getTBinR/articles/intro.html) vignette and for a case study using the package see the [Exploring Global Trends in Tuberculosis Incidence Rates](https://www.samabbott.co.uk/getTBinR/articles/case_study_global_trends.html) vignette.
## Installation
Install the CRAN version:
```{r cran-installation, eval = FALSE}
install.packages("getTBinR")
```
Alternatively install the development version from GitHub:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("seabbs/getTBinR")
```
## Documentation
[](https://www.samabbott.co.uk/getTBinR/)
[](https://www.samabbott.co.uk/getTBinR/dev)
[](https://www.samabbott.co.uk/getTBinR/articles/intro.html)
[](https://www.samabbott.co.uk/getTBinR/reference/index.html)
## Testing
[](https://travis-ci.org/seabbs/getTBinR)
[](https://ci.appveyor.com/project/seabbs/getTBinR)
[](https://codecov.io/github/seabbs/getTBinR?branch=master)
## Quick start
Lets get started quickly by mapping and then plotting TB incidence rates in the United Kingdom. First map the most recently available global TB incidence rates (this will also download and save both the TB burden data and its data dictionary, if they are not found locally, to R's temporary directory),
```{r map-tb-incidence-eur, fig.height = 4, fig.width = 8}
getTBinR::map_tb_burden(metric = "e_inc_100k")
```
Then compare TB incidence rates in the UK to TB incidence rates in other countries in the region,
```{r plot-tb-incidence-eur, fig.height = 8}
getTBinR::plot_tb_burden_overview(metric = "e_inc_100k",
countries = "United Kingdom",
compare_to_region = TRUE)
```
In order to compare the changes in incidence rates over time, in the region, plot the annual percentage change,
```{r plot-tb-incidence-eur-per, fig.height = 8}
getTBinR::plot_tb_burden_overview(metric = "e_inc_100k",
countries = "United Kingdom",
compare_to_region = TRUE,
annual_change = TRUE)
```
Now plot TB incidence rates over time in the United Kingdom, compared to TB incidence rates in Europe and globally.
```{r plot-tb-incidence-uk-compare}
getTBinR::plot_tb_burden_summary(metric = "e_inc_num",
metric_label = "e_inc_100k",
countries = "United Kingdom",
compare_all_regions = FALSE,
compare_to_region = TRUE,
compare_to_world = TRUE)
```
We can repeat the above plot but this time only for the UK - this allows us to get a clear picture of trends in TB incidence rates in the UK.
```{r plot-tb-incidence-uk}
getTBinR::plot_tb_burden(metric = "e_inc_100k",
countries = "United Kingdom")
```
We might be interested in having some of this information in tablular form. We can either generate a short summary for the most recent year of available data with the following,
```{r summarise-metric}
getTBinR::summarise_metric(metric = "e_inc_100k",
countries = "United Kingdom")
```
Or a more detailed dataset as follows,
```{r summarise_tb_burden}
getTBinR::summarise_tb_burden(metric = "e_inc_num",
stat = "rate",
countries = "United Kingdom",
compare_to_world = FALSE,
compare_to_region = FALSE)
```
Here `e_inc_num` is used rather than `e_inc_100k` as incidence rates are being estimated based on notified cases. This allows country level rates to be compared to regional (using `compare_to_region = TRUE`) and global (using `compare_to_world = TRUE`) rates.
See [Functions](https://www.samabbott.co.uk/getTBinR/reference/index.html) for more details of the functions used (note the fuzzy country matching, all functions will try to exactly match your country request and if that fails will search for partial matches) and for more package functionality. We could make the plots above interactive by specifying `interactive = TRUE`
## Additional datasets
On top of the core datasets provided by default, `getTBinR` also supports importing multiple other datasets. These include data on latent TB, HIV surveillance, intervention budgets, and outcomes. The currently supported datasets are listed below,
```{r additional_datasets}
knitr::kable(getTBinR::available_datasets[, 1:4])
```
These datasets can be imported into `R` by supplying the name of the required dataset to the `additional_datasets` argument of `get_tb_burden` (or any of the various plotting/summary functions). Alternatively, they can all be imported in one go using `additional_datasets = "all"`, as below,
```{r import-additional_datasets}
getTBinR::get_tb_burden(additional_datasets = "all")
```
Once imported, these datasets can be used in the plotting and summary functions provided by `getTBinR` (by passing them to their `df` argument or using the `additional_datasets` argument in each function). See the contributing section if their are any other datasets that you think `getTBinR` should support or if you have suggestions for better descriptions for each dataset.
## WHO-inspired themes and palettes.
The WHO makes use of several standardised plot themes and colour palettes. `getTBinR` implements these so that the package can be easily used internally at the WHO or by those collaborating with the WHO.
```{r who-theme-example, message = FALSE, warning = FALSE}
getTBinR::plot_tb_burden_summary(countries = "United Kingdom",
compare_all_regions = FALSE,
compare_to_region = TRUE) +
getTBinR::theme_who() +
getTBinR::scale_colour_who(reverse = TRUE) +
getTBinR::scale_fill_who(reverse = TRUE)
```
## Shiny dashboard
To explore the package functionality in an interactive session, or to investigate TB without having to code extensively in R, a shiny dashboard has been built into the package. This can either be used locally using,
```{r run-dash, eval = FALSE}
getTBinR::run_tb_dashboard()
```
Or accessed [online](http://www.seabbs.co.uk/shiny/ExploreGlobalTB). Any metric in the WHO data can be explored, with country selection using the built in map, and animation possible by year.
## Country report
To get a detailed overview of TB in a country of your choice run the following, alternatively available from the built in dashboard above.
```{r, eval = FALSE}
## Code saves report into your current working directory
render_country_report(country = "United Kingdom", save_dir = ".")
```
## Contributing
File an issue [here](https://github.com/seabbs/getTBinR/issues) if there is a feature, or a dataset, that you think is missing from the package, or better yet submit a pull request!
Please note that the `getTBinR` project is released with a [Contributor Code of Conduct](https://github.com/seabbs/getTBinR/blob/master/.github/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms.
## Citing
If using `getTBinR` please consider citing the package in the relevant work. Citation information can be generated in R using the following (after installing the package),
```{r}
citation("getTBinR")
```
## Docker
This package has been developed in docker based on the `rocker/tidyverse` image, to access the development environment enter the following at the command line (with an active docker daemon running),
```{bash, eval = FALSE}
docker pull seabbs/gettbinr
docker run -d -p 8787:8787 -e USER=getTBinR -e PASSWORD=getTBinR --name getTBinR seabbs/gettbinr
```
The rstudio client can be accessed on port `8787` at `localhost` (or your machines ip). The default username is getTBinR and the default password is getTBinR. Alternatively, access the development environment via [binder](https://mybinder.org/v2/gh/seabbs/getTBinR/master?urlpath=rstudio).