From 2209c24deab771bd7e28116dcc42075da84420a5 Mon Sep 17 00:00:00 2001
From: Jerid Francom <francojc@wfu.edu>
Date: Sun, 10 Mar 2024 18:43:36 -0400
Subject: [PATCH] more cran checklist items

---
 DESCRIPTION               |  2 +-
 R/confirm_permission.R    |  3 ++-
 R/get_archive_data.R      |  2 +-
 cran-comments.md          |  2 +-
 man/confirm_permission.Rd | 19 -------------------
 man/get_archive_data.Rd   |  2 +-
 6 files changed, 6 insertions(+), 24 deletions(-)
 delete mode 100644 man/confirm_permission.Rd

diff --git a/DESCRIPTION b/DESCRIPTION
index 9da14cd..1eee845 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -3,7 +3,7 @@ Title: Quantitative Text Kit
 Version: 0.9.5
 Authors@R:
     person("Jerid", "Francom", , "francojc@wfu.edu",
-    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
index 56900b4..2dddaa4 100644
--- 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
index 4943b3a..c6618ba 100644
--- 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
index 62c010f..858617d 100644
--- 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
deleted file mode 100644
index 5b267e2..0000000
--- a/man/confirm_permission.Rd
+++ /dev/null
@@ -1,19 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/confirm_permission.R
-\name{confirm_permission}
-\alias{confirm_permission}
-\title{Confirm permission to use data}
-\usage{
-confirm_permission()
-}
-\value{
-TRUE if the user confirms permission, FALSE otherwise
-}
-\description{
-This function is for internal use only.
-}
-\details{
-This function confirms that the user has permission to use the data.
-If not, the script is returns FALSE and stops.
-}
-\keyword{internal}
diff --git a/man/get_archive_data.Rd b/man/get_archive_data.Rd
index b68a20f..1248f5f 100644
--- a/man/get_archive_data.Rd
+++ b/man/get_archive_data.Rd
@@ -20,7 +20,7 @@ If \code{FALSE}, the function will prompt the user to confirm permission.
 Setting this to \code{TRUE} is useful for reproducible workflows.}
 }
 \value{
-Download and extract the archive file
+NULL, the archive file is unarchived in the target directory
 }
 \description{
 Possible file types include .zip, .gz, .tar, and .tgz