more cran checklist items

qtalr · Mar 10, 2024 · 2209c24 · 2209c24
1 parent c477aca
commit 2209c24
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 24 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -3,7 +3,7 @@ Title: Quantitative Text Kit
 Version: 0.9.5
 Authors@R:
     person("Jerid", "Francom", , "[email protected]",
-    role = c("aut", "cre"),
+    role = c("aut", "cre", "cph"),
     comment = c(ORCID = "0000-0001-5972-6330"))
 Description: Support package for the textbook "An Introduction to
     Quantitative Text Analysis for Linguists: Reproducible Research using

diff --git a/R/confirm_permission.R b/R/confirm_permission.R
@@ -4,9 +4,10 @@
 #'
 #' This function confirms that the user has permission to use the data.
 #' If not, the script is returns FALSE and stops.
-#'
+#' @noRd
 #' @keywords internal
 #' @return TRUE if the user confirms permission, FALSE otherwise
+#'
 confirm_permission <- function() {
   # Confirm that the user has permission to use the data
   # If not, stop the script

diff --git a/R/get_archive_data.R b/R/get_archive_data.R
@@ -11,7 +11,7 @@
 #' If `FALSE`, the function will prompt the user to confirm permission.
 #' Setting this to `TRUE` is useful for reproducible workflows.
 #'
-#' @returns Download and extract the archive file
+#' @returns NULL, the archive file is unarchived in the target directory
 #'
 #' @importFrom utils download.file unzip untar
 #' @importFrom tools file_ext

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,5 +1,5 @@
 ## R CMD check results
 
-0 errors | 0 warnings | 0 note
+0 errors | 0 warnings | 1 note
 
 * This is a new release.
diff --git a/man/confirm_permission.Rd b/man/confirm_permission.Rd
diff --git a/man/get_archive_data.Rd b/man/get_archive_data.Rd