prep for cran

DESCRIPTION

@@ -1,9 +1,14 @@
 Package: redistverse
 Title: Easily Install and Load Redistricting Software
-Version: 0.1.0.9000
+Version: 0.1.0
 Authors@R: c(
-    person("Christopher T.", "Kenny", email = "christopherkenny@fas.harvard.edu", role = c("aut", "cre")),
-    person("Cory", "McCartan", email = "cmccartan@g.harvard.edu", role = "aut"),
+    person(given = "Christopher T.",
+       family = "Kenny",
+       role = c("aut", "cre"),
+       email = "christopherkenny@fas.harvard.edu",
+       comment = c(ORCID = "0000-0002-9386-6860")),
+    person(given = "Cory", family = "McCartan", email = "mccartan@psu.edu", 
+       role = "aut", comment = c(ORCID = "0000-0002-6251-669X")),
     person("tidyverse contributors", role = "ctb", comment = "attach code adapted from tidyverse."))
 Description: The 'redistverse' is a set of packages for redistricting
     data downloading, spatial preprocessing, simulation, analysis, and 
@@ -22,14 +27,17 @@ Imports:
     easycensus,
     PL94171,
     alarmdata,
-    cli
+    cli,
+    birdie
 Suggests: 
     wacolors,
-    testthat (>= 3.0.0)
+    testthat (>= 3.0.0),
+    spelling
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 URL: https://github.com/alarm-redist/redistverse, https://alarm-redist.org/redistverse/
 BugReports: https://github.com/alarm-redist/redistverse/issues
 Config/testthat/edition: 3
+Language: en-US

R/attach.R

@@ -1,7 +1,7 @@
 # adopted from `tidyverse`
 
 core_pkgs <- c("redist", "redistmetrics", "ggredist", "geomander", "sf")
-xtra_pkgs <- c("PL94171", "tinytiger", "alarmdata", "censable", "easycensus")
+xtra_pkgs <- c("PL94171", "tinytiger", "alarmdata", "censable", "easycensus", "birdie")
 # geocoder? birdie?
 
 core_unloaded <- function() {

R/cache.R

@@ -0,0 +1,48 @@
+#" Summarize caches for `redistverse` packages
+#"
+#" @param packages character vector of package names. Default is `c("alarmdata", "tinytiger")`.
+#"
+#" @return a vector of paths to the cache directories for the specified packages
+#" @export
+#"
+#" @examples
+#" redistverse_cache_status()
+redistverse_cache_status <- function(packages = c("alarmdata", "tinytiger")) {
+  if ("alarmdata" %in% packages) {
+    packages[packages == "alarmdata"] <- "alarm"
+  }
+
+  check_fns <- c(
+    tinytiger = tinytiger::tt_cache_path,
+    alarm = alarmdata::alarm_cache_path
+  )
+
+  use_cache <- logical(length(packages))
+  paths <- character(length(packages))
+  for (i in seq_along(packages)) {
+    use_cache[i] <- getOption(x = paste0(packages[i], ".use_cache"), default = FALSE)
+    if (use_cache[i] && !is.null(check_fns[[packages[i]]])) {
+      paths[i] <- check_fns[[packages[i]]]()
+    } else {
+      paths[i] <- getOption(paste0(packages[i], ".cache_dir"), default = NA_character_)
+    }
+  }
+
+  ul <- cli::cli_ul()
+  for (i in seq_along(packages)) {
+    if (is.na(paths[i])) {
+      if (isFALSE(use_cache[i])) {
+        cli::cli_li("{.pkg {packages[i]}}: cache is not enabled.")
+      } else {
+        cli::cli_li("{.pkg {packages[i]}}: cache enabled but not found.")
+      }
+    } else {
+      cli::cli_li("{.pkg {packages[i]}}: cache is {.path {paths[i]}}.")
+    }
+  }
+  cli::cli_end(ul)
+
+  names(paths) <- packages
+
+  invisible(paths)
+}

R/redistverse-package.R

@@ -15,4 +15,5 @@ ignore_unused_imports <- function() {
   redistmetrics::by_plan
   sf::st_crs
   tinytiger::tt_voting_districts
+  birdie::birdie
 }

README.Rmd

@@ -16,6 +16,9 @@ knitr::opts_chunk$set(
 # redistverse <img src="man/figures/logo.png" align="right" height="208" />
 
 <!-- badges: start -->
+[![redistverse status
+badge](https://alarm-redist.r-universe.dev/badges/redistverse)](https://alarm-redist.r-universe.dev/redistverse)
+[![R-CMD-check](https://github.com/alarm-redist/redistverse/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/alarm-redist/redistverse/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
 The `redistverse` is a set of packages for redistricting data downloading, spatial 
@@ -53,3 +56,4 @@ Related packages are installed:
 - [alarmdata](https://alarm-redist.org/alarmdata/)
 - [easycensus](https://corymccartan.com/easycensus/)
 - [censable](https://christophertkenny.com/censable/)
+- [birdie](https://corymccartan.com/birdie/)

README.md

@@ -42,3 +42,4 @@ Related packages are installed:
 - [alarmdata](https://alarm-redist.org/alarmdata/)
 - [easycensus](https://corymccartan.com/easycensus/)
 - [censable](https://christophertkenny.com/censable/)
+- [birdie](https://corymccartan.com/birdie/)

inst/WORDLIST

@@ -0,0 +1,11 @@
+CMD
+ORCID
+alarmdata
+censable
+easycensus
+geomander
+ggredist
+redist
+redistmetrics
+tidyverse
+tinytiger

tests/spelling.R

@@ -0,0 +1,3 @@
+if(requireNamespace('spelling', quietly = TRUE))
+  spelling::spell_check_test(vignettes = TRUE, error = FALSE,
+                             skip_on_cran = TRUE)