1
2
3
4# praise
5
6> Praise Users
7
8[![Linux Build Status](https://travis-ci.org/gaborcsardi/praise.svg?branch=master)](https://travis-ci.org/gaborcsardi/praise)
9[![Windows Build status](https://ci.appveyor.com/api/projects/status/github/gaborcsardi/praise?svg=true)](https://ci.appveyor.com/project/gaborcsardi/praise)
10[![](http://www.r-pkg.org/badges/version/praise)](http://www.r-pkg.org/pkg/praise)
11[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/praise)](http://www.r-pkg.org/pkg/praise)
12
13
14Build friendly R packages that praise their users if they have
15done something good, or they just need it to feel better.
16
17## Installation
18
19
20```r
21devtools::install_github("gaborcsardi/praise")
22```
23
24## Usage
25
26
27```r
28library(praise)
29praise()
30```
31
32```
33#> [1] "You are super-excellent!"
34```
35
36You can supply a template, and `praise()` fills in random words of the specified
37part of speech:
38
39
40```r
41praise("${EXCLAMATION}! You have done this ${adverb_manner}!")
42```
43
44```
45#> [1] "AYE! You have done this enormously!"
46```
47
48Note that capitalization in the inserted words will be the same as in the template:
49
50
51```r
52praise("${Exclamation}! ${EXCLAMATION}!-${EXCLAMATION}! This is just ${adjective}!")
53```
54
55```
56#> [1] "Yowza! MMHM!-YAHOO! This is just praiseworthy!"
57```
58
59Currently supported parts of speech:
60
61
62```r
63names(praise_parts)
64```
65
66```
67#> [1] "adjective"     "adverb"        "adverb_manner" "created"
68#> [5] "creating"      "exclamation"   "rpackage"
69```
70
71## License
72
73MIT © [Gabor Csardi](https://github.com/gaborcsardi), [Sindre Sorhus](http://sindresorhus.com)
74