README.Rmd

---
output: 
  md_document:
    variant: markdown_github
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/XKCDdata)](https://cran.r-project.org/package=XKCDdata)
[![CRAN_Download_Badge](http://cranlogs.r-pkg.org/badges/XKCDdata)](https://CRAN.R-project.org/package=XKCDdata)
[![CRAN_Download_Badge](http://cranlogs.r-pkg.org/badges/grand-total/XKCDdata)](https://CRAN.R-project.org/package=XKCDdata)

# XKCDdata

XKCDdata is a little package to get data from individual [xkcd](https://xkcd.com/) comics, written by Randall Munroe.

## Installation
 
```{r eval = FALSE}
install.packages("XKCDdata")

# or: 

# install.packages("devtools")
devtools::install_github("RobertMyles/XKCDdata")
```

## Example:  

Let's get data on this comic (it's number 1421):  

![https://imgs.xkcd.com/comics/future_self.png](https://imgs.xkcd.com/comics/future_self.png) 


```{r}
library(XKCDdata)

get_comic(comic = 1421)

```


Or you can get a list of comics pretty easily using purrr, `apply()` or for loops. With purrr, it would be something like: 

```{r, eval = FALSE}
# list of comics:
cm <- c(1421, 641, 87, 92)
purrr::map_df(cm, get_comic)
```

Then you could plot it XKCD-style with the [xkcd](http://xkcd.r-forge.r-project.org/) package if you wanted. 

## Viewing Comics

Thanks to [Colin](https://github.com/ColinFay), you can view the comics inside your default Viewer (in the Viewer pane if you're on RStudio)! Give it a shot with:  

```{r}
print_xkcd(1)
```