[R-pkg-devel] R Package Development -- PDF Manual without Index

[Jeff Newmiller]

CRAN doesn't care about whether devtools is happy. R CMD check --as-cran needs to work, e.g. as in [1].

Devtools is a convenience tool to help put all of the necessary bits in the right places in your source code according to [2]. But if there is any disagreement about what works, devtools is never the definitive answer.

If you put your current package source code online, as in on GitHub and share that here, then someone may be able to help you bridge the gap to satisfy both devtools and CRAN.

[1] https://kbroman.org/pkg_primer/pages/check.html
[2] https://cran.r-project.org/doc/manuals/R-exts.html

On September 2, 2023 11:50:57 AM PDT, John Carter Hall <jchall using scitovation.com> wrote:
>Hello R-Package-Devel Mailing List,
>
>I am new to R package development, and am having to limp a project across the line after my organization has gone through significant changes in recent weeks.
>As such, I am emailing to understand what I can do to solve an error I am having:
>
>The Error
>
>Flavor: r-devel-linux-x86_64-debian-gcc
>Check: PDF version of manual without index, Result: ERROR
>
>The Issue
>
>For whatever reason, the R CMD check​ desires different fields in the DESCRIPTION file than does the devtools::check() function (particularly w.r.t. the 'Author' field), and so I have to use devtools to build/check the package. The devtools::build_manual function, however, does not work, and so I am forced to utilize Rd2pdf to create my PDF manual.
>
>I have to make the manual via Windows due to issues with an Ubuntu installation of my package. However, the package is intended for Linux/Debian audiences.
>
>What I Need Help With
>
>I believe I have the manual created. I do not know if this manual needs to be created when CRAN does their checks, but I have the document (I am comparing its appearance to the manual of ggplot2​, and the structure is similar). I do not know where it needs to be located. I have tried the root directory of the package, the doc​ folder, etc... but nothing works.
>
>What can I do?
>
>Best,
>Carter
>
>
>	[[alternative HTML version deleted]]
>
>______________________________________________
>R-package-devel using r-project.org mailing list
>https://stat.ethz.ch/mailman/listinfo/r-package-devel

-- 
Sent from my phone. Please excuse my brevity.