Add kjv_bible standalone function

Author: andrewheiss

NAMESPACE

@@ -1,3 +1,4 @@
 # Generated by roxygen2: do not edit by hand
 
+export(kjv_bible)
 export(lds_scriptures)

R/kjv_bible.R

@@ -0,0 +1,55 @@
+#' Tidy data frame of the King James Version of the Bible
+#'
+#' Returns a tidy data frame of the King James Version of the Bible, with one
+#' verse for every row. There are several columns, including: \code{text}, which
+#' contains the text of each verse, \code{book_title}, the book of scripture,
+#' \code{chapter_number}, the chapter, and \code{verse_number}, the verse
+#' number. There are a dozen other columns as well: see "Details" for complete
+#' descriptions.
+#'
+#' Importantly, none of the title columns are ordered factors. It is the
+#' responsibility of the user to create ordered factors of book and volume
+#' titles when plotting results.
+#'
+#' @details Every row in the dataset is a verse, and there are 19 columns of
+#'   metadata:
+#'   \describe{
+#'     \item{\code{volume_id}}{Unique id number for the volume (1 = Old Testament, 2 = New Testament, etc.)}
+#'     \item{\code{book_id}}{Unique id number for the book (1 = Genesis, 2 = Exodus, etc.)}
+#'     \item{\code{chapter_id}}{Unique id number for the chapter (50 = Genesis 50, 51 = Exodus 1, etc.)}
+#'     \item{\code{verse_id}}{Unique id number for the verse (31 = Genesis 1:31, 32 = Genesis 2:1)}
+#'     \item{\code{volume_title}}{Name of the volume}
+#'     \item{\code{book_title}}{Name of the book}
+#'     \item{\code{volume_long_title}}{Full name of the volume}
+#'     \item{\code{book_long_title}}{Full name of the book}
+#'     \item{\code{volume_subtitle}}{Subtitle of the volume}
+#'     \item{\code{book_subtitle}}{Subtitle of the book}
+#'     \item{\code{volume_short_title}}{Volume abbreviation}
+#'     \item{\code{book_short_title}}{Book abbreviation}
+#'     \item{\code{volume_lds_url}}{Volume abbreviation used at scriptures.lds.org}
+#'     \item{\code{book_lds_url}}{Book abbreviation used at scriptures.lds.org}
+#'     \item{\code{chapter_number}}{Chapter (not unique; Genesis 50 = 50, Exodus 1 = 1, etc.)}
+#'     \item{\code{verse_number}}{Verse (not unique; Genesis 1:31 = 31, Genesis 2:1 = 1)}
+#'     \item{\code{text}}{Scripture text}
+#'     \item{\code{verse_title}}{Combined book, chapter, and verse (e.g. Genesis 1:1)}
+#'     \item{\code{verse_short_title}}{Abbreviated combined book, chapter, and verse (e.g. Gen. 1:1)}
+#'   }
+#'
+#' @return A data frame with 31102 rows and 19 columns
+#'
+#' @name kjv_bible
+#'
+#' @examples
+#' library(dplyr)
+#'
+#' kjv_bible() %>%
+#'   group_by(volume_title, book_title) %>%
+#'   summarise(total_verses = n())
+#'
+#' @export
+kjv_bible <- function() {
+  ret <- rbind(scriptuRs::old_testament,
+               scriptuRs::new_testament)
+
+  structure(ret, class = c("tbl_df", "tbl", "data.frame"))
+}

README.md

@@ -10,7 +10,7 @@ This package provides access to the full text of the Standard Works for The Chur
 - `doctrine_and_covenants`: The Doctrine and Covenants
 - `pearl_of_great_price`: The Pearl of Great Price
 
-There is also a function `lds_scriptures()` that returns a tidy data frame of all 5 volumes of scripture.
+There is also a function `lds_scriptures()` that returns a tidy data frame of all 5 volumes of scripture, as well as a `kjv_bible()` function that returns a tidy data frame of just the Old and New Testaments.
 
 Unlike other packages like [**janeaustenr**](https://github.com/juliasilge/janeaustenr), this package does not provide ordered factors for book or volume names. It is up to the user to put books and/or volumes in the needed order when analyzing or plotting the data.
 
@@ -38,7 +38,7 @@ scriptures <- lds_scriptures()
 
 scriptures %>% 
   group_by(volume_title, book_title) %>%
-  summarise(total_verses = n())
+  summarize(total_verses = n())
 #> # A tibble: 87 x 3
 #> # Groups:   volume_title [?]
 #>    volume_title   book_title total_verses
@@ -56,6 +56,30 @@ scriptures %>%
 #> # ... with 77 more rows
 ```
 
+And here's how to use `kvj_bible()`:
+
+```r
+bible <- kjv_bible()
+
+bible %>% 
+  group_by(volume_title, book_title) %>%
+  summarize(total_verses = n())
+#> # A tibble: 66 x 3
+#> # Groups:   volume_title [?]
+#>    volume_title  book_title      total_verses
+#>    <chr>         <chr>                  <int>
+#>  1 New Testament 1 Corinthians            437
+#>  2 New Testament 1 John                   105
+#>  3 New Testament 1 Peter                  105
+#>  4 New Testament 1 Thessalonians           89
+#>  5 New Testament 1 Timothy                113
+#>  6 New Testament 2 Corinthians            257
+#>  7 New Testament 2 John                    13
+#>  8 New Testament 2 Peter                   61
+#>  9 New Testament 2 Thessalonians           47
+#> 10 New Testament 2 Timothy                 83
+#> # ... with 56 more rows
+```
 
 ## Code of Conduct
 

man/kjv_bible.Rd

@@ -0,0 +1,19 @@
+# tests for kjv_bible function
+
+context("Tidy dataframe with King James bible")
+
+suppressPackageStartupMessages(library(dplyr))
+
+test_that("tidy frame for KJV bible is right", {
+  # Does this have the right number of lines?
+  bible <- kjv_bible()
+  expect_equal(nrow(bible), 31102)
+  expect_equal(ncol(bible), 19)
+
+  # Are the lines spread across each volume correctly?
+  bible_test <- bible %>%
+    group_by(volume_title) %>%
+    summarise(total_verses = n())
+  expect_equal(nrow(bible_test), 2)
+  expect_equal(ncol(bible_test), 2)
+})