forked from poissonconsulting/yesno
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
98 lines (71 loc) · 3.05 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
[](https://www.tidyverse.org/lifecycle/#stable)
[](https://travis-ci.org/poissonconsulting/yesno)
[](https://ci.appveyor.com/project/poissonconsulting/yesno)
[](https://codecov.io/gh/poissonconsulting/yesno)
[](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
[](https://cran.r-project.org/package=yesno)
[](https://cran.r-project.org/package=yesno)
[](https://doi.org/10.5281/zenodo.1218397)
# yesno
## Introduction
Provides two functions.
The first, `yesno()`, asks a custom yes-no question with three variable responses.
The order and phrasing of the possible responses varies randomly to ensure the user consciously chooses (as opposed to automatically types their response).
The second, `yesno2()`, ask a yes-no question with two custom responses.
## Demonstration
```
yesno("Do you like ", R.Version()$nickname ,"?")
Do you like Bug in Your Hair?
1: Definitely
2: No way
3: No
Selection: 1
[1] TRUE
yesno("Do you like ", R.Version()$nickname ,"?")
Do you like Bug in Your Hair?
1: No way
2: Uhhhh... Maybe?
3: I agree
Selection: 2
[1] FALSE
> yesno2("Do you like this question?", yes = "I really do")
Do you like this question?
1: I really do
2: No
Selection: 1
[1] TRUE
```
## Installation
To install the latest development version from [GitHub](https://github.com/poissonconsulting/yesno)
```
# install.packages("devtools")
devtools::install_github("poissonconsulting/yesno")
```
Alternatively install the latest development version from the Poisson drat [repository](https://github.com/poissonconsulting/drat) using
```
# install.packages("drat")
drat::addRepo("poissonconsulting")
install.packages("yesno")
```
## Citation
```{r, comment="", echo=FALSE}
citation(package = "yesno")
```
## Contribution
Please report any [issues](https://github.com/poissonconsulting/yesno/issues).
[Pull requests](https://github.com/poissonconsulting/yesno/pulls) are always welcome.
Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md).
By participating in this project you agree to abide by its terms.
## Inspiration
- The `yesno()` function is based on the internal function with the same name from [devtools](https://github.com/hadley/devtools) (modified to return TRUE if the user answers yes).