minor fixes for CRAN resubmission

.Rbuildignore

@@ -7,3 +7,4 @@
 ^pkgdown$
 ^\.github$
 ^cran-comments\.md$
+^CRAN-SUBMISSION$

.gitignore

@@ -6,3 +6,4 @@
 .quarto
 docs
 forgts.Rproj
+inst/doc

CRAN-SUBMISSION

@@ -0,0 +1,3 @@
+Version: 0.0.1
+Date: 2025-01-28 18:16:08 UTC
+SHA: ba72d268c6ce86d607d3e8115ebc7342cefdd247

DESCRIPTION

@@ -4,7 +4,7 @@ Version: 0.0.1
 Authors@R: 
     person("Luis D.", "Verde Arregoitia", , "[email protected]", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0001-9520-6543"))
-Description: Reads data plus formatting from a spreadsheet file and creates a gt object with the same data and formatting.
+Description: Reads cell contents plus formatting from a spreadsheet file and creates an editable 'gt' object with the same data and formatting. Supports the most commonly-used cell and text styles including colors, fills, font weights and decorations, and borders.
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)

R/dataset_documentation.R

@@ -2,7 +2,7 @@
 #'
 #' Open XML Format Spreadsheet with 1 sheet, 5 columns, and 8 rows. Toy dataset
 #' with data on measurements for rodent specimens, extracted from Verde
-#' Arregoitia et al. (2017; https://doi.org/10.5281/zenodo.201147). Cells and
+#' Arregoitia et al. (2017; \doi{doi:10.5281/zenodo.201147}). Cells and
 #' cell content have formatting added at random for demonstration purposes.
 #'
 #'

R/forgts_main.R

@@ -13,9 +13,9 @@
 #' @export
 #'
 #' @examples
-#' \dontrun{
-#' forgts("yourpath/yourspreadsheet.xlsx")
-#' }
+#' example_spreadsheet <- system.file("extdata/rodentsheet.xlsx", package = "forgts")
+#' forgts(example_spreadsheet)
+#'
 forgts <- function(file, sheet = NULL) {
   if (is.null(sheet)) {
     sheet <- 1L

R/get_formatting.R

@@ -10,9 +10,9 @@
 #'
 #' @importFrom rlang .data
 #' @examples
-#' \dontrun{
-#' get_formatting("yourpath/yourspreadsheet.xlsx")
-#' }
+#' example_file <- system.file("extdata/rodentsheet.xlsx", package = "forgts")
+#' get_formatting(example_file)
+#'
 #' @export
 #'
 get_formatting <- function(xlfilepath, sheet = NULL) {

R/styling.R

@@ -10,13 +10,12 @@
 #' @export
 #'
 #' @examples
-#' \dontrun{
-#' sprdsht_data <- read_excel("yourpath/yourspreadsheet.xlsx")
+#' example_spreadsheet <- system.file("extdata/rodentsheet.xlsx", package = "forgts")
+#' sprdsht_data <- readxl::read_excel(example_spreadsheet)
 #' gt_table <- gt::gt(sprdsht_data)
-#' format_long <- get_formatting("yourpath/yourspreadsheet.xlsx")
+#' format_long <- get_formatting(example_spreadsheet)
 #' format_ready <- translate_defs(format_long)
 #' apply_styling(gt_table, format_ready)
-#' }
 #'
 #' @importFrom gt gt
 apply_styling <- function(gt_object, formatRdy) {

R/translate_formatting.R

@@ -12,10 +12,10 @@
 #' @importFrom dplyr case_when if_else mutate
 #'
 #' @examples
-#' \dontrun{
-#' format_long <- get_formatting("yourpath/yourspreadsheet.xlsx")
+#' example_spreadsheet <- system.file("extdata/rodentsheet.xlsx", package = "forgts")
+#' format_long <- get_formatting(example_spreadsheet)
 #' translate_defs(format_long)
-#' }
+#'
 translate_defs <- function(format_long) {
   # match styling arguments
   format_long_stl <- dplyr::mutate(format_long,

cran-comments.md

@@ -1,14 +1,16 @@
 ## R CMD check results
 
-0 errors | 0 warnings | 2 notes
+0 errors | 0 warnings | 0 notes
 Winbuilder: OK
 
-notes pertain to new submission
-
 ## Rhub v2 checks: ALL OK
 Test environments:
 * linux x86_64-pc-linux-gnu Ubuntu 24.04.1 LTS 
 * macOS Ventura 13.7.2 
 * Windows Server 2022 x64 (build 20348)
 
-* This is a new release.
+## Resubmission notes
+
+* More descriptive text in 'Description' field
+* Package names quoted in Title field
+* All exported functions now with working examples that run OK