prepare for CRAN submission

colindouglas · Feb 27, 2024 · 6b5d79f · 6b5d79f
1 parent dfc0ab3
commit 6b5d79f
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 20 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -11,7 +11,7 @@ Authors@R:
            family = "Scriven",
            role = c("aut", "cph"),
            email = "rmscriven@gmail.com"))
-Date: 2023-07-05
+Date: 2024-02-27
 Maintainer: Colin Douglas <colin@douglas.science>
 Description: A collection of tools to import and structure the (currently) single-season
     event, game-log, roster, and schedule data available from <https://www.retrosheet.org>.

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,8 @@
+# retrosheet 1.1.6
+  * Updated format of documentation to pass CRAN checks
+  * Updated `getRetrosheet()` to account for new paths on retrosheet.org
+  * Updated two tests to account for changed location of All Star Team rosters
+
 # retrosheet 1.1.5
   * Updated tests to account for addition of All Star teams to Retrosheet data
   * Added checks to testing so it 'fails gracefully' when `retrosheet.org` is not available

diff --git a/README.Rmd b/README.Rmd
@@ -17,7 +17,7 @@ knitr::opts_chunk$set(
 
 [![R-CMD-check](https://github.com/colindouglas/retrosheet/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/colindouglas/retrosheet/actions/workflows/R-CMD-check.yaml)
 [![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/retrosheet)](https://cran.r-project.org/package=retrosheet)
-[![License: MIT](https://img.shields.io/badge/license-GPL%20(%3E%3D%202)-blue.svg)](https://opensource.org/license/gpl-2-0/)
+[![License: GPL 2.0](https://img.shields.io/badge/license-GPL%20(%3E%3D%202)-blue.svg)](https://opensource.org/license/gpl-2-0)
 [![GitHub commit](https://img.shields.io/github/last-commit/colindouglas/retrosheet)](https://github.com/colindouglas/retrosheet/commit/main)
 [![Downloads](https://cranlogs.r-pkg.org/badges/last-week/retrosheet)](https://cran.r-project.org/package=retrosheet)
 <!-- badges: end -->

diff --git a/README.md b/README.md
@@ -5,8 +5,8 @@
 
 [![R-CMD-check](https://github.com/colindouglas/retrosheet/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/colindouglas/retrosheet/actions/workflows/R-CMD-check.yaml)
 [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/retrosheet)](https://cran.r-project.org/package=retrosheet)
-[![License:
-MIT](https://img.shields.io/badge/license-GPL%20(%3E%3D%202)-blue.svg)](https://opensource.org/license/gpl-2-0/)
+[![License: GPL
+2.0](https://img.shields.io/badge/license-GPL%20(%3E%3D%202)-blue.svg)](https://opensource.org/license/gpl-2-0)
 [![GitHub
 commit](https://img.shields.io/github/last-commit/colindouglas/retrosheet)](https://github.com/colindouglas/retrosheet/commit/main)
 [![Downloads](https://cranlogs.r-pkg.org/badges/last-week/retrosheet)](https://cran.r-project.org/package=retrosheet)

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,27 +1,22 @@
-A minor revision to resolve CRAN Package Check errors arising from changes to 
-the structure of the source data. Package now also includes resource checks to
-ensure that tests 'fail gracefully' if retrosheet.org is not available.
+A minor revision to resolve CRAN Package Check note 'lost braces in \\itemize',
+as per change noted in second item: https://developer.r-project.org/blosxom.cgi/R-devel/NEWS/2023/10/11
 
-I have also updated the three URLs in the README with HTTP status codes >= 300.
+Additionally, a remote path has been updated to reflect changed location of source data.
 
-There are three unique NOTEs when building this package on R-Hub. My 
-understanding is that all three are related to issues with R-Hub, not the
-package. To be sure, I've also added testing via Github Actions to confirm.
-All five builds via Github Actions come back OK.
 
 ## Test environments 
 * locally
-    * Mint 21.1 Vera, R 4.3.1
+    * Mint 21.1 Vera, R 4.3.2
         * 0 errors ✓ | 0 warnings ✓ | 0 notes ✓
 
 * via winbuilder
-    * Windows Server 2022 x64, R Under development (unstable) (2023-07-05 r84643 ucrt)
+    * Windows Server 2022 x64, R Under development (unstable) (2024-02-19 r85946 ucrt)
         * Status: OK
 
 * via R-Hub
     * Windows Server 2022, R-devel, 64 bit
         * Status: 2 NOTEs
-    * Ubuntu Linux 20.04.1 LTS, R-release, GCC 
+    * Ubuntu Linux 20.04.1 LTS, R-release, GCC
         * Status: 1 NOTE
     * Fedora Linux, R-devel, clang, gfortran
         * Status: 1 NOTE
@@ -40,15 +35,16 @@ All five builds via Github Actions come back OK.
 
 ## R-Hub Notes:
 
-* only on Windows R-devel: 
+* On Windows R-devel: 
     * NOTE 1: `Found the following files/directories: ''NULL''`
     * NOTE 2: `Found the following files/directories: 'lastMiKTeXException'`
-    * Both notes seem to be related to a bug in R-Hub and can safely be ignored
-        * Note 1 Issue: https://github.com/r-hub/rhub/issues/560
-        * Note 2 Issue: https://github.com/r-hub/rhub/issues/503
+    * Both notes seem to be related to bugs in R-Hub and can safely be ignored
+        * Note 1 issue: https://github.com/r-hub/rhub/issues/560
+        * Note 2 issue: https://github.com/r-hub/rhub/issues/503
 * On Ubuntu R-release and Fedora R-devel:
     * NOTE: `Skipping checking HTML validation: no command 'tidy' found`
-    * I believe this to be an issue with R-Hub, I cannot add `tidy` to their PATH
+        * This is an issue with R-Hub (I cannot add `tidy` to their path)
+        * Issue: https://github.com/r-hub/rhub/issues/548
 
 ## Downstream dependencies
 None