roxygen2 not fully updating DESCRIPTION file

Question

I\'m making my first package rlandscape, using Roxygen2 and trying to follow the plain Roxygen vignette since Roxygen2 doesn\'t have one.

As in the vig

Answer 1

roxygen2 is working just as intended, but I experienced the same confusion when I first used it to document a package. The important bit to understand is that there are a couple of different package-describing files in the mix.

• When the roxygen markup in rlandscape-package.R is processed, it produces a file rlandscape-package.Rd in the man directory of your source package. This in turn produces the documentation you see when you type ?rlandscape or ?"rlandscape-package".

• The DESCRIPTION file in the top directory of your source tree is a completely separate beast. Although it happens to produce a help file that you can see (via help(package="rlandscape")), it has many other more important roles in directing package production. The only way that it is touched/affected by roxygen2 is that the collate_roclet() function (executed when you roxygenize() your package) will perform merges with the Collate field in a pre-existing DESCRIPTION file (as describe on p 10 of this pdf).

The main take home message is that even when using roxygen2, if you want to make changes to your DESCRIPTION file, you'll need to do it by directly editing it.