-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
112 lines (77 loc) · 3.59 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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# proverbs <img src="https://github.com/bradlindblad/proverbs/blob/dev/man/figures/logo.png?raw=true" align="right" width="120"/>
*"When the whirlwind passes, the wicked is no more, but the righteous has an everlasting foundation"*
*- Proverbs 10:25 (NASB)*
<!-- badges: start -->
[](https://github.com/bradlindblad/proverbs/actions) [](https://github.com/bradlindblad/proverbs/actions/workflows/pkgdown.yaml) [](https://app.codecov.io/gh/bradlindblad/proverbs?branch=master) [](https://lifecycle.r-lib.org/articles/stages.html#stable) [](https://CRAN.R-project.org/package=proverbs)
<!-- badges: end -->
A simple package to grab a Bible proverb corresponding to the day of the month.
## Installation
Install the released version of proverbs from CRAN:
``` r
install.packages("proverbs")
```
You can install the development version of proverbs like so:
``` r
# install.packages("devtools")
devtools::install_github("bradlindblad/proverbs")
```
## Usage
The proverbs package was built to do one thing: print out a daily proverb to your R console. There are 31 proverbs, and up to 31 days in each month.
Many people like to read a proverb for each day of the month, so they end up reading proverbs once a month, twelve times a year.
This package prints the chapter of proverbs that corresponds to that day of the month; ie. on the 21st of June proverbs will print Proverbs 21.
### proverb()
This is the main function:
``` r
proverbs::proverb()
```
``` text
Proverbs 30
For Sunday, January 30 2022
1 The words of Agur the son of Jakeh; the revelation:
the man says to Ithiel,
to Ithiel and Ucal:
2 “Surely I am the most ignorant man,
and don’t have a man’s understanding.
3 I have not learned wisdom,
neither do I have the knowledge of the Holy One.
...
```
### translations()
You can also change the Bible translation to one of many open source/public versions. Check these out with this function:
``` r
proverbs::translations()
```
``` text
── Bible Translations Available ────────────
• esv: English Standard Version -requires API key
• bbe: Bible in Basic English
• kjv: King James Version
• web: World English Bible (default)
• webbe: World English Bible, British Edition
• almeida: João Ferreira de Almeida (portuguese)
• rccv: Romanian Corrected Cornilescu Version
── Pass the Bible translation you choose above to proverb(), like:
proverb(translation = 'kjv')
proverb(translation = 'bbe')
```
You can pass those translation codes to `proverbs::proverb()`
``` r
proverbs::proverb(translation = "kjv")
```
Note that an API key is needed to access the ESV translation. See [this vignette](https://bradlindblad.github.io/proverbs/articles/esv_api_key.html).
## Credit
The proverbs package takes advantage of the awesome free Bible api <https://bible-api.com/>, maintained by [Tim Morgan](https://timmorgan.org/). Thanks, Tim!
## Contact me
I can be reached at my website [technistema.com](https://technistema.com)