cranspection

DESCRIPTION

@@ -3,11 +3,11 @@ Title: Spread the Love for R Packages with Poetry
 Version: 2024.2.14
 Authors@R: 
     person("Romain", "François", email = "romain@tada.science", role = c("aut", "cre"))
-Description: Spread the love for R packages with poetry.
+Description: Uses 'ChatGPT' <https://openai.com/> to create poems about R packages.
+   Currently contains the roses() function to make "roses are red, ..." style 
+   poems and the prompt() function to only assemble the prompt without submitting 
+   it to 'ChatGPT'. 
 License: MIT + file LICENSE
-Suggests: 
-    testthat (>= 3.0.0)
-Config/testthat/edition: 3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.1

R/roses.R

@@ -5,17 +5,19 @@
 #'
 #' @param pkg A package
 #' @param hint extra information to add to the prompt
-#' @param emoji Should the poem include empojis.
+#' @param emoji Should the poem include emojis ?
 #' @param ... Passed to [openai::create_chat_completion()]
 #'
-#' @return A poem generated by ChatGPT.
+#' @return A poem generated by ChatGPT via [openai::create_chat_completion()]
 #'
 #' @importFrom glue glue
 #' @importFrom openai create_chat_completion
 #' @examples
 #' prompt("dplyr")
 #'
 #' \dontrun{
+#'   # this needs the OPENAI_API_KEY environment variable
+#'   # to be set. See https://irudnyts.github.io/openai/
 #'   roses("dplyr")
 #' }
 #' @export