CRAN fixes

cole-brokamp · Oct 31, 2024 · cf0a5b4 · cf0a5b4
1 parent 691661e
commit cf0a5b4
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 10 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -5,3 +5,4 @@
 ^docs$
 ^pkgdown$
 ^cran-comments\.md$
+^CRAN-SUBMISSION$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -4,7 +4,7 @@ Version: 0.6.0
 Authors@R: 
     person("Cole", "Brokamp", , "cole@colebrokamp.com", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0002-0289-3151"))
-Description: Data frame, tibble, or tbl objects are converted to data package objects using specific metadata labels (name, version, title, homepage, description). A data package object (`dpkg`) can be written to disk as a 'parquet' file or released to a 'GitHub' repository. Data package objects can be read into R from online repositories and downloaded files are cached locally across R sessions.
+Description: Data frame, tibble, or tbl objects are converted to data package objects using specific metadata labels (name, version, title, homepage, description). A data package object ('dpkg') can be written to disk as a 'parquet' file or released to a 'GitHub' repository. Data package objects can be read into R from online repositories and downloaded files are cached locally across R sessions.
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)

diff --git a/LICENSE b/LICENSE
@@ -1,2 +1,2 @@
 YEAR: 2024
-COPYRIGHT HOLDER: lbl authors
+COPYRIGHT HOLDER: dpkg authors
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2024 lbl authors
+Copyright (c) 2024 dpkg authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,7 @@
 # dpkg 0.6.0
 
+- Initial CRAN release.
+
 # dpkg 0.5.1
 
 * Initial CRAN submission.
diff --git a/R/dpkg_release_gh.R b/R/dpkg_release_gh.R
@@ -119,9 +119,6 @@ use_dpkg_badge <- function(x) {
 
 #' get github token from GITHUB_PAT environment variable or use bundled token if unset
 #' @keywords internal
-#' @examples
-#' # withr::with_envvar(c(GITHUB_PAT = ""), get_gh_token())
-#' # get_gh_token()
 get_gh_token <- function() {
   gh_token <- Sys.getenv("GITHUB_PAT")
   if (gh_token == "") {

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,5 +1,13 @@
 ## R CMD check results
 
+Resubmission of dpkg 0.6.0:
+
+- Used only undirected quotation marks in description text
+- Removed example in unexported function
+- Removed commented out examples
+- I believe \dontrun is needed in my case because running the example would error without a user-provided github repository and github API key.
+- I've confirmed that the DESCRIPTION file contains all of the authors, contributors, and copyright holders in the Authors@R section.
+
 0 errors | 0 warnings | 0 notes
 
 * This is a new release.

diff --git a/man/get_gh_token.Rd b/man/get_gh_token.Rd