final check before submission to CRAN

jpmonteagudo28 · Aug 2, 2024 · 699ab9a · 699ab9a
1 parent 57994ad
commit 699ab9a
Show file tree

Hide file tree

Showing 18 changed files with 45 additions and 40 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -7,7 +7,7 @@ Authors@R:
     role = c("aut", "cre", "cph"),
     comment = c(ORCID = "0009-0003-6465-6658"))
 Maintainer: JP Monteagudo <[email protected]>
-Description: Generate (de)motivational quotes and Shakespearean word combinations (bard–bits) that a user can consider for their personal projects. Each of the package functions takes two arguments, cat which default to any, and a a numeric or character seed to ensure reproducible results. 
+Description: Generate motivational quotes and Shakespearean word combinations (bard–bits) that a user can consider for their personal projects. Each of the package functions takes two arguments, cat which default to any, and a a numeric or character seed to ensure reproducible results. 
 License: GPL (>= 3)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
@@ -16,5 +16,7 @@ LazyData: true
 URL: https://github.com/jpmonteagudo28/despair
 BugReports: https://github.com/jpmonteagudo28/despair/issues
 Suggests: 
+    spelling,
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
+Language: en-US
diff --git a/R/bard.bits.R b/R/bard.bits.R
@@ -5,21 +5,21 @@
 #' 'The Bard of Avon' and the bits ( Shakespeare's characters, places, professions) used to come up with coherent combinations.
 #'
 #' @details
-#' When the category is 'any' (the default), the function combines Shakespeare's adjectives,
+#' When the category is "any" (the default), the function combines Shakespeare's adjectives,
 #' DSM-5 adjectives, colors and the characters, jobs, animals and things data frames
 #' to then sample one adjective and one noun from each of the two combinations.
 #'
-#' When the category is 'alliterate', the function combines the adjectives and colors
+#' When the category is "alliterate", the function combines the adjectives and colors
 #' data frames and the animals and characters data frame. After an adjective is selected,
 #' the first letter will be used to match against a noun.
 #'
-#' When the category is 'character', the function will derive a bard bit from a data frame of Shakespeare's
+#' When the category is "character", the function will derive a bard bit from a data frame of Shakespeare's
 #' characters and the adjectives data frame.
 #'
-#' When the category is 'jobs', the function will derive a bard bit from the adjectives and colors data frame
+#' When the category is "jobs", the function will derive a bard bit from the adjectives and colors data frame
 #' and sample one value from the Shakespeare's jobs data frame.
 #'
-#' When the category is 'dsm_5', the function will derive a bard bit from the combined jobs,
+#' When the category is "dsm_5", the function will derive a bard bit from the combined jobs,
 #' characters, animals and the DSM-5 adjectives data frame.
 #'
 #' @param cat a category to be used as bard–bit. Defaults to "any", but "character",

diff --git a/R/demotivate.R b/R/demotivate.R
@@ -15,7 +15,7 @@
 #' When cat is 'any' (default), the function combines all category data frames and then
 #' samples from the new,combined data frame.
 #'
-#' There are a total of six categories: family, life, work, science, tv, and rednecks.
+#' There are a total of six categories: family, life, work, science, TV, and rednecks.
 #' When a specific category is chosen the function will sample from a demotivational quote data
 #' frame and output a random quote for your spiritual and mental decay.
 #'

diff --git a/R/motivate.R b/R/motivate.R
@@ -4,8 +4,8 @@
 #' \code{motivate()} is a tool to lift up even the unmotivated individual.
 #' Use with caution and remember— DO take it personally.
 #'
-#' @param cat a motivational category to choose from. The function defaults to 'any'.
-#' @param seed a numeric or character seed for reproducible results. The function defaults to 'NULL'.
+#' @param cat a motivational category to choose from. The function defaults to "any".
+#' @param seed a numeric or character seed for reproducible results. The function defaults to "NULL".
 #'
 #' @return \code{motivate()} takes a preferred category and an optional reproducible seed
 #' to return a motivational quote for the user to feel better at any given time.

diff --git a/README.Rmd b/README.Rmd
@@ -18,7 +18,7 @@ knitr::opts_chunk$set(
 
 # Overview
 
-`despair` is a package inspired by Shakespeare's work and his well-known pessimism. It allows the user to create short, clever codes called bard–bits inspired by Shakespeare's work and use daily (de)motivational quotes for personal use or to share with others.
+`despair` is a package inspired by Shakespeare's work and his well-known pessimism. It allows the user to create short, clever codes called bard–bits inspired by Shakespeare's work and use daily demotivational quotes for personal use or to share with others.
 
 ## Installation
 

diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 
 `despair` is a package inspired by Shakespeare’s work and his well-known
 pessimism. It allows the user to create short, clever codes called
-bard–bits inspired by Shakespeare’s work and use daily (de)motivational
+bard–bits inspired by Shakespeare’s work and use daily demotivational
 quotes for personal use or to share with others.
 
 ## Installation

diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -2,7 +2,7 @@ pandoc: 3.1.1
 pkgdown: 2.1.0
 pkgdown_sha: ~
 articles: {}
-last_built: 2024-08-02T17:20Z
+last_built: 2024-08-02T19:05Z
 urls:
   reference: https://despair.jpmonteagudo.com/reference
   article: https://despair.jpmonteagudo.com/articles
diff --git a/docs/reference/bard.bits.html b/docs/reference/bard.bits.html
diff --git a/docs/reference/demotivate.html b/docs/reference/demotivate.html
diff --git a/docs/reference/motivate.html b/docs/reference/motivate.html
diff --git a/docs/reference/set.char.seed.html b/docs/reference/set.char.seed.html
diff --git a/docs/search.json b/docs/search.json
diff --git a/man/bard.bits.Rd b/man/bard.bits.Rd
diff --git a/man/demotivate.Rd b/man/demotivate.Rd