Skip to content

Commit

Permalink
updated readme with CRAN install, updated site
Browse files Browse the repository at this point in the history
  • Loading branch information
seabbs committed Jan 5, 2018
1 parent 45cf50d commit 2e63a07
Show file tree
Hide file tree
Showing 20 changed files with 108 additions and 90 deletions.
12 changes: 10 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,24 @@ knitr::opts_chunk$set(

# Get TB Data in R

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/getTBinR)](https://cran.r-project.org/package=getTBinR)
[![Travis-CI Build Status](https://travis-ci.org/seabbs/getTBinR.svg?branch=master)](https://travis-ci.org/seabbs/getTBinR)
[![Coverage Status](https://img.shields.io/codecov/c/github/seabbs/getTBinR/master.svg)](https://codecov.io/github/seabbs/getTBinR?branch=master)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/seabbs/getTBinR?branch=master&svg=true)](https://ci.appveyor.com/project/seabbs/getTBinR)
[![Coverage Status](https://img.shields.io/codecov/c/github/seabbs/getTBinR/master.svg)](https://codecov.io/github/seabbs/getTBinR?branch=master)
[![metacran downloads](http://cranlogs.r-pkg.org/badges/getTBinR)](https://cran.r-project.org/package=getTBinR)

Quickly and easily import analysis ready TB burden data, from the World Health Orgnaisation (WHO), into R. The aim of the package is to speed up access to high quality TB burden data, using a simple R interface. Generic plotting functions are provided to allow for rapid graphical exploration of the WHO TB data. This package is inspired by a blog [post](https://incidental-ideas.org/2017/03/03/who-tuberculosis-data-ggplot2/), which looked at WHO TB incidence rates. See [here](http://www.who.int/about/copyright/en/) for the WHO data permissions.

## Installation

You can install getTBinR from github with:
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")
Expand Down
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,20 @@
Get TB Data in R
================

[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/getTBinR)](https://cran.r-project.org/package=getTBinR) [![Travis-CI Build Status](https://travis-ci.org/seabbs/getTBinR.svg?branch=master)](https://travis-ci.org/seabbs/getTBinR) [![Coverage Status](https://img.shields.io/codecov/c/github/seabbs/getTBinR/master.svg)](https://codecov.io/github/seabbs/getTBinR?branch=master) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/seabbs/getTBinR?branch=master&svg=true)](https://ci.appveyor.com/project/seabbs/getTBinR)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/getTBinR)](https://cran.r-project.org/package=getTBinR) [![Travis-CI Build Status](https://travis-ci.org/seabbs/getTBinR.svg?branch=master)](https://travis-ci.org/seabbs/getTBinR) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/seabbs/getTBinR?branch=master&svg=true)](https://ci.appveyor.com/project/seabbs/getTBinR) [![Coverage Status](https://img.shields.io/codecov/c/github/seabbs/getTBinR/master.svg)](https://codecov.io/github/seabbs/getTBinR?branch=master) [![metacran downloads](http://cranlogs.r-pkg.org/badges/getTBinR)](https://cran.r-project.org/package=getTBinR)

Quickly and easily import analysis ready TB burden data, from the World Health Orgnaisation (WHO), into R. The aim of the package is to speed up access to high quality TB burden data, using a simple R interface. Generic plotting functions are provided to allow for rapid graphical exploration of the WHO TB data. This package is inspired by a blog [post](https://incidental-ideas.org/2017/03/03/who-tuberculosis-data-ggplot2/), which looked at WHO TB incidence rates. See [here](http://www.who.int/about/copyright/en/) for the WHO data permissions.

Installation
------------

You can install getTBinR from github with:
Install the CRAN version:

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

Alternatively install the development version from GitHub:

``` r
# install.packages("devtools")
Expand All @@ -27,9 +33,9 @@ getTBinR::map_tb_burden(metric = "e_inc_100k",
download_data = TRUE,
save = TRUE)
#> Downloading data from: https://extranet.who.int/tme/generateCSV.asp?ds=estimates
#> Saving data to: /tmp/Rtmpu7EWiK/TB_burden.rds
#> Saving data to: /tmp/RtmpdY8moE/TB_burden.rds
#> Downloading data from: https://extranet.who.int/tme/generateCSV.asp?ds=dictionary
#> Saving data to: /tmp/Rtmpu7EWiK/TB_data_dict.rds
#> Saving data to: /tmp/RtmpdY8moE/TB_data_dict.rds
#> 1 results found for your variable search for e_inc_100k
```

Expand All @@ -42,8 +48,8 @@ getTBinR::plot_tb_burden_overview(metric = "e_inc_100k",
countries = "United Kingdom",
compare_to_region = TRUE,
interactive = FALSE)
#> Loading data from: /tmp/Rtmpu7EWiK/TB_burden.rds
#> Loading data from: /tmp/Rtmpu7EWiK/TB_data_dict.rds
#> Loading data from: /tmp/RtmpdY8moE/TB_burden.rds
#> Loading data from: /tmp/RtmpdY8moE/TB_data_dict.rds
#> 1 results found for your variable search for e_inc_100k
```

Expand All @@ -56,8 +62,8 @@ getTBinR::plot_tb_burden(metric = "e_inc_100k",
countries = "United Kingdom",
facet = "country",
interactive = FALSE)
#> Loading data from: /tmp/Rtmpu7EWiK/TB_burden.rds
#> Loading data from: /tmp/Rtmpu7EWiK/TB_data_dict.rds
#> Loading data from: /tmp/RtmpdY8moE/TB_burden.rds
#> Loading data from: /tmp/RtmpdY8moE/TB_data_dict.rds
#> 1 results found for your variable search for e_inc_100k
```

Expand Down
32 changes: 16 additions & 16 deletions docs/articles/intro.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified docs/articles/intro_files/figure-html/plot-incidence-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/articles/intro_files/figure-html/plot-incidence-facet-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 2e63a07

Please sign in to comment.