forked from jennybc/bingo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
114 lines (77 loc) · 3.46 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
---
output:
github_document:
toc: true
toc_depth: 2
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
<!-- badges: start -->
[](https://travis-ci.org/jennybc/bingo)
[](https://ci.appveyor.com/project/jennybc/bingo)
[](https://codecov.io/gh/jennybc/bingo?branch=master)
<!-- badges: end -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
# so that the same bingo card will be generated every time
set.seed(10)
```
# bingo
Generate Bingo cards.
Currently has built-in squares for SuperBowl 50 :football: and data / spreadsheet craziness :chart_with_downwards_trend: and more. Or you can provide your own text for the squares.
Make printable Bingo cards **without installing anything** via this Shiny app:
* <http://daattali.com/shiny/bingo/>
* It's also included in the package (see [below](#run-shiny-app-locally)).
Feel free to help us make these cards less ugly or to explore new bingo topics! PRs welcome :grin:.
## Installation
Install from GitHub with:
```{r eval = FALSE}
# install.packages("devtools")
devtools::install_github("jennybc/bingo")
```
## SuperBowl Example
```{r}
library(bingo)
## see some of the SuperBowl 50 squares
tail(get_topic("football"))
## make 8 bingo cards
bc <- bingo(n_cards = 8, words = get_topic("football"))
## print them to PDF
plot(bc)
```
Here's what one looks like:
## "Open" and Bad Data Examples
We offer two sets of squares inspired by the ~~pain~~ joy of dealing with [`#otherpeoplesdata`](https://twitter.com/search?q=%23otherpeoplesdata&src=tyah)
Use `get_topic("open-data")` to get squares based on this tweet from Chris McDowall:
> For two weeks I noted issues encountered as I used NZ govt data. Today I collected enough to make a bingo card. *[\@fogonwater, January 3, 2016](https://twitter.com/fogonwater/status/683785398112260097)*
Use `get_topic("bad-data")` to get squares inspired by the [Quartz guide to bad data](https://github.com/Quartz/bad-data-guide):
> An exhaustive reference to problems seen in real-world data along with suggestions on how to resolve them.... Most of these problems can be solved. Some of them can't be solved and that means you should not use the data. Others can't be solved, but with precautions you can continue using the data.
```{r}
## see some Open Data squares
tail(get_topic("open-data"))
## see some Bad Data squares
tail(get_topic("bad-data"))
## make a single Open Data bingo card
## Note that "open-data" is the default topic, so you could alternatively use: bc <- bingo().
bc <- bingo(words = get_topic("open-data"))
## make a custom bingo blend from the open and bad data squares
bc <- bingo(words = c(get_topic("open-data"), get_topic("bad-data")))
## print it
plot(bc, pdf_base = "open-data-")
```
Here's an Open Data bingo card:
```{r clean-up, include = FALSE}
crap <- c(list.files(pattern = "bingo-[0-9]+.pdf"),
list.files(pattern = "open-data-[0-9]+.pdf"))
file.remove(crap)
```
## Run Shiny app locally
To run [the app we're running remotely](http://daattali.com/shiny/bingo/) on your own machine, do this:
```{r eval = FALSE}
launch()
```