Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #36

Merged
merged 2 commits into from
Jul 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: lovecraftr
Type: Package
Title: H. P. Lovecraft's works, for text analysis
Version: 0.2.2
Version: 0.2.3
Authors@R:
person("Jordan", "Bradford", email = "[email protected]", role = c("aut", "cre"))
Description: A collection of H. P. Lovecraft's works as R datasets.
Expand Down
270 changes: 135 additions & 135 deletions R/data.R

Large diffs are not rendered by default.

9 changes: 4 additions & 5 deletions R/lovecraft.R
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
#' @title Lovecraft's Corpus
#'
#' @description
#' See `?lovecraftr::lovecraft_corpus` for documentation
#' See \code{\link[lovecraftr:lovecraft]{lovecraftr:lovecraft}} for documentation.
#'
#' @return A data frame of Lovecraft's corpus
#' @return A tibble of Lovecraft's corpus.
#'
#' @export
#'
#' @examples
#' lovecraft_corpus()
#' @seealso \code{\link[lovecraftr:lovecraft]{lovecraftr:lovecraft}}
#' @usage lovecraft_corpus()
lovecraft_corpus <- function() {
lovecraftr::lovecraft
}
6 changes: 3 additions & 3 deletions data-raw/generate_data.R
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ header <- "# This documentation is generated by a script, do not edit by hand
"

docs_template <- "{header}
#' @title Dataset of {formatted_title}
#' @description A dataset containing text of H. P. Lovecraft's {formatted_title}
#' @title {formatted_title}
#' @description A dataset containing text of H. P. Lovecraft's {formatted_title}.
#' @usage data({dataset_name})
#' @format A character vector with {num_vectors} elements, with roughly 80 characters per line.
#' @docType data
Expand Down Expand Up @@ -69,7 +69,7 @@ lovecraft <- dplyr::bind_rows(dataset_list)
num_rows <- scales::number(nrow(lovecraft), big.mark = ",")
num_cols <- ncol(lovecraft)
corpus_docs <- glue::glue("{header}
#' @title Dataset of Lovecraft's corpus
#' @title Dataset of Lovecraft's Corpus
#' @description A dataset containing text of all the H. P. Lovecraft works available in this package.
#' @usage data(lovecraft)
#' @format A tibble with {num_rows} rows and {num_cols} columns:
Expand Down
4 changes: 2 additions & 2 deletions man/at_the_mountains_of_madness.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/azathoth.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/beyond_the_wall_of_sleep.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/celephais.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/cool_air.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/dagon.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/dreams_in_the_witch_house.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/ex_oblivione.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/facts_concerning_the_late_arthur_jermyn_and_his_family.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/from_beyond.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/he.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/herbert_west_reanimator.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/hypnos.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/imprisoned_with_the_pharoahs.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/in_the_vault.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/lovecraft.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions man/lovecraft_corpus.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/medusas_coil.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/memory.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/nyarlathotep.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading