Repo updates

.Rbuildignore

@@ -5,6 +5,6 @@
 ^.Rhistory$
 ^\.Rproj\.user$
 ^data-raw$
-^.pre-commit-config.yaml$
 ^\.github$
 ^LICENSE\.md$
+^\.pre-commit-config\.yaml$

.github/workflows/README-check.yaml

@@ -1,4 +1,6 @@
 # Workflow derived from https://github.com/quarto-dev/quarto-actions/tree/v2/render
+# Ensures that README.md is up to date with README.qmd
+# by rendering, committing, and pushing changes to PR
 on:
   pull_request:
     paths:

R/data.R

@@ -1210,7 +1210,7 @@
 
 #' @title Dataset of Lovecraft's corpus
 #'
-#' @description A dataset containing text of all the H. P. Lovecraft works available in {lovecraftr}
+#' @description A dataset containing text of all the H. P. Lovecraft works available in this package
 #'
 #' @examples
 #' data("lovecraft")

README.md

@@ -93,6 +93,10 @@ data("lovecraft")
 
 See [CONTRIBUTING.md](./.github/CONTRIBUTING.md).
 
+## License
+
+MIT. See [LICENSE.md](./LICENSE.md).
+
 ## Citation
 
 Please cite this package if you use it.

README.qmd

@@ -70,6 +70,10 @@ data("lovecraft")
 
 See [CONTRIBUTING.md](/.github/CONTRIBUTING.md).
 
+## License
+
+MIT. See [LICENSE.md](/LICENSE.md).
+
 ## Citation
 
 Please cite this package if you use it.

data-raw/create_sticker.R

@@ -1,3 +1,8 @@
+#!/usr/bin/env Rscript
+
+# This script generates the hex sticker for the packages
+
+
 signature_url <- "https://upload.wikimedia.org/wikipedia/commons/a/a7/Lovecraft_signature_1924-02-02.png"
 signature_dest_path <- file.path("data-raw", "stickers", "signature.png")
 raw_log_path <- file.path("data-raw", "stickers", "logo-raw.png")
@@ -21,7 +26,7 @@ hexSticker::sticker(
   u_y = 0.1,
   u_color = "black",
   filename = raw_log_path,
-  dpi: 600
+  dpi = 600
 )
 
 usethis::use_logo(raw_log_path)

data-raw/generate_data.R

@@ -58,7 +58,7 @@ num_cols <- ncol(lovecraft)
 corpus_docs <- glue::glue("{header}
 #' @title Dataset of Lovecraft's corpus
 #'
-#' @description A dataset containing text of all the H. P. Lovecraft works available in {{lovecraftr}}
+#' @description A dataset containing text of all the H. P. Lovecraft works available in this package
 #'
 #' @examples
 #' data(\"lovecraft\")