Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR applies some housekeeping changes to the package's DESCRIPTION file. Critically, the "BuildManual" field is added and set to
true
.As far as I have been able to suss out, as of R v4.3.2,
R CMD build
requires theBuildManual
field to betrue
in order for the package's PDF manual to be generated, even if there are install-time or render-time/Sexpr
macros are present in the package's man/*.Rd files. Currently, the following NOTE is being thrown by CRAN checks (the last line is the problematic one):I first encountered this issue while cutting the release for
SeuratObject
v5.0.2 but attributed it to a problem with my local environment. Upon digging deeper, I noticed that the successful build used R v4.2.2 and was eventually able to pinpoint the issue to this change in the R source code, which updated the default value for the "BuildManual" field fromTRUE
toFALSE
🕵️Curiously, CRAN's documentation on writing R extensions appears to describe the old behavior 🤷
The only other non-cosmetic change introduced in this PR is that the "Type" field was dropped from the package's DESCRIPTION—this field defaults to "Package" and can only take one other value ("Frontend"). The main motivation for dropping it is for consistency with
Seurat
🤓