Respond to CRAN checks for version 0.1.7
Closed this issue · 2 comments
Overview
After completing #45, I resubmitted to CRAN. I received the following check failing message:
Dear maintainer,
package codebookr_0.1.7.tar.gz does not pass the incoming checks automatically, please see the following pre-tests:
Windows: <https://win-builder.r-project.org/incoming_pretest/codebookr_0.1.7_20240214_024055/Windows/00check.log>
Status: 1 NOTE
Debian: <https://win-builder.r-project.org/incoming_pretest/codebookr_0.1.7_20240214_024055/Debian/00check.log>
Status: 1 NOTE
Last released version's CRAN status: OK: 10, NOTE: 2
See: <https://cran.r-project.org/web/checks/check_results_codebookr.html>
CRAN Web: <https://cran.r-project.org/package=codebookr>
Please fix all problems and resubmit a fixed version via the webform.
If you are not sure how to fix the problems shown, please ask for help on the R-package-devel mailing list:
<https://stat.ethz.ch/mailman/listinfo/r-package-devel>
If you are fairly certain the rejection is a false positive, please reply-all to this message and explain.
More details are given in the directory:
<https://win-builder.r-project.org/incoming_pretest/codebookr_0.1.7_20240214_024055/>
The files will be removed after roughly 7 days.
No strong reverse dependencies to be checked.
Best regards,
CRAN teams' auto-check service
Flavor: r-devel-linux-x86_64-debian-gcc, r-devel-windows-x86_64
Check: CRAN incoming feasibility, Result: Note_to_CRAN_maintainers
Maintainer: 'Brad Cannell <[brad.cannell@gmail.com](mailto:brad.cannell@gmail.com)>'
Flavor: r-devel-linux-x86_64-debian-gcc, r-devel-windows-x86_64
Check: Rd files, Result: NOTE
checkRd: (-1) cb_add_col_attributes.Rd:41-51: Lost braces in \itemize; meant \describe ?
checkRd: (-1) cb_add_col_attributes.Rd:52-61: Lost braces in \itemize; meant \describe ?
checkRd: (-1) cb_add_col_attributes.Rd:62-95: Lost braces in \itemize; meant \describe ?
checkRd: (-1) cb_add_col_attributes.Rd:96-131: Lost braces in \itemize; meant \describe ?
checkRd: (-1) cb_add_col_attributes.Rd:132-141: Lost braces in \itemize; meant \describe ?
We need to figure out how to fix and then resubmit.
2024-02-14
It seemed like having the closing brace for \item
tags on its own line was causing the problem. For example, Lines 41-51 looked like this:
#' \item{description:}{
#' Although you may add any text you desire to the
#' `description` attribute, it is intended to be used describe the
#' question/process that generated the data contained in the column.
#' Many statistical software packages refer to this as a variable label.
#' If the data was imported from SAS, Stata, or SPSS with variable labels
#' using the `haven` package, `codebook` will automatically recognize them.
#' There is no need to manually create them. However, you may overwrite the
#' imported variable label for any column by adding a `description`
#' attribute.
#' }
I tried moving the closing curly brace up to be inline with the text like this:
#' \item{description:}{
#' Although you may add any text you desire to the
#' `description` attribute, it is intended to be used describe the
#' question/process that generated the data contained in the column.
#' Many statistical software packages refer to this as a variable label.
#' If the data was imported from SAS, Stata, or SPSS with variable labels
#' using the `haven` package, `codebook` will automatically recognize them.
#' There is no need to manually create them. However, you may overwrite the
#' imported variable label for any column by adding a `description`
#' attribute.}
But, it didn't help. I still got this error from devtools::check_win_devel()
:
checking Rd files
checkRd: (-1) cb_add_col_attributes.Rd:41-50: Lost braces in \itemize; meant \describe ?
checkRd: (-1) cb_add_col_attributes.Rd:51-59: Lost braces in \itemize; meant \describe ?
checkRd: (-1) cb_add_col_attributes.Rd:60-92: Lost braces in \itemize; meant \describe ?
checkRd: (-1) cb_add_col_attributes.Rd:93-127: Lost braces in \itemize; meant \describe ?
checkRd: (-1) cb_add_col_attributes.Rd:128-136: Lost braces in \itemize; meant \describe ?
The line numbers changed, but the error didn't. I wonder if I should try just getting rid of the \itemize
and \item
tags, and just use pure markdown instead. I could also try using \describe
instead of \itemize
.
Using \describe
instead of \itemize
seemed to work. I'm resubmitting to CRAN.
2024-02-14
Dear package maintainer,
this notification has been generated automatically.
Your package codebookr_0.1.7.tar.gz has been built for Windows and
will be published within 24 hours in the corresponding CRAN directory.
R version 4.3.2 (2023-10-31 ucrt)
All the best,
Uwe Ligges
(Maintainer of binary packages for Windows)