fix: use globalVariables for state.abb/state.name, regenerate docs

@importFrom does not work for base R lazy data objects — replaced with
utils::globalVariables() in the package file to suppress the R CMD check
NOTE. Removed the invalid @importFrom datasets tag from utils.R.

Also commits all man/ and NAMESPACE changes from devtools::document().

DESCRIPTION

@@ -1,29 +1,29 @@
-Package: civilytics
-Type: Package
-Title: Utilities Functions for Civilytics
-Version: 0.2.0
-Authors@R:
-    person("Jared", "E. Knowles", email = "jared@civilytics.com",
-           role = c("aut", "cre"))
-Description: House R functions for Civilytics Consulting LLC. This package
-    implements a variety of useful functions for creating and branding analyses
-    produced by Civilytics Consulting LLC.
-License: LGPL (>= 3)
-URL: https://gitea.civilytics.org/Civilytics/civilyticsR
-BugReports: https://gitea.civilytics.org/Civilytics/civilyticsR/issues
-Depends:
-    R (>= 4.1.0)
-Imports:
-    ggplot2,
-    jpeg,
-    png,
-    stringr,
-    gridExtra,
-    grid,
-    stringdist
-Encoding: UTF-8
-Suggests:
-    testthat (>= 3.0.0),
-    tidycensus
-RoxygenNote: 7.3.2
-Config/testthat/edition: 3
+Package: civilytics
+Type: Package
+Title: Utilities Functions for Civilytics
+Version: 0.2.0
+Authors@R:
+    person("Jared", "E. Knowles", email = "jared@civilytics.com",
+           role = c("aut", "cre"))
+Description: House R functions for Civilytics Consulting LLC. This package
+    implements a variety of useful functions for creating and branding analyses
+    produced by Civilytics Consulting LLC.
+License: LGPL (>= 3)
+URL: https://gitea.civilytics.org/Civilytics/civilyticsR
+BugReports: https://gitea.civilytics.org/Civilytics/civilyticsR/issues
+Depends:
+    R (>= 4.1.0)
+Imports:
+    ggplot2,
+    jpeg,
+    png,
+    stringr,
+    gridExtra,
+    grid,
+    stringdist
+Encoding: UTF-8
+Suggests:
+    testthat (>= 3.0.0),
+    tidycensus
+Config/testthat/edition: 3
+Config/roxygen2/version: 8.0.0

NAMESPACE

@@ -1,8 +1,8 @@
 # Generated by roxygen2: do not edit by hand
 
-export(agresti_coull_interval)
 export(add_logo)
 export(add_logo_ga)
+export(agresti_coull_interval)
 export(clopper_pearson)
 export(countCleanr)
 export(countDots)
@@ -41,8 +41,6 @@ export(z_gap_test)
 export(z_univariate)
 import(ggplot2)
 importFrom(ggplot2,theme)
-importFrom(datasets,state.abb)
-importFrom(datasets,state.name)
 importFrom(graphics,plot)
 importFrom(graphics,rasterImage)
 importFrom(grid,grid.draw)

R/civilytics-package.R

@@ -7,4 +7,8 @@
 ## usethis namespace: end
 NULL
 
+# state.abb and state.name are lazy data from the datasets package (base R).
+# They cannot be imported via @importFrom — suppress the R CMD check NOTE here.
+utils::globalVariables(c("state.abb", "state.name"))
+
 

R/utils.R

@@ -171,7 +171,6 @@ na_sum <- function(x) {
 #' Title
 #'
 #' @param x a vector of state names
-#' @importFrom datasets state.abb state.name
 #' @return state abbreviations matching state naems provided in X
 #' @export
 #'

man/agresti_coull_interval.Rd

@@ -4,18 +4,22 @@
 \alias{agresti_coull_interval}
 \title{Calculate the Agresti-Coull interval}
 \usage{
-agresti_coull_interval(num, den, conf.level)
+agresti_coull_interval(num, den, conf.level = 0.95)
 }
 \arguments{
-\item{num}{a number of successes}
+\item{num}{number of successes}
 
-\item{den}{a number of trials}
+\item{den}{number of trials}
 
-\item{conf.level}{default 0.95, set the confidence interval to return}
+\item{conf.level}{default 0.95, confidence level for the interval}
 }
 \value{
-an interval
+three values forming the lower bound, observed proportion, and upper bound
 }
 \description{
 Calculate the Agresti-Coull interval
 }
+\examples{
+agresti_coull_interval(20, 40)
+agresti_coull_interval(2, 100, conf.level = 0.99)
+}

man/civilytics-package.Rd

@@ -6,6 +6,23 @@
 \alias{civilytics-package}
 \title{civilytics: Utilities Functions for Civilytics}
 \description{
-House R functions for Civilytics Consulting LLC This package implements a variety of useful functions for creating and branding analyses produced by Civilytics Consulting LLC.
+House R functions for Civilytics Consulting LLC. This package implements a variety of useful functions for creating and branding analyses produced by Civilytics Consulting LLC.
+}
+\seealso{
+Useful links:
+\itemize{
+  \item \url{https://gitea.civilytics.org/Civilytics/civilyticsR}
+  \item Report bugs at \url{https://gitea.civilytics.org/Civilytics/civilyticsR/issues}
+}
+
+}
+\author{
+\strong{Maintainer}: Jared E. Knowles \email{jared@civilytics.com}
+
+Authors:
+\itemize{
+  \item Jared E. Knowles \email{jared@civilytics.com}
+}
+
 }
 \keyword{internal}