pkgutils.package: The 'pkgutils' package

Description Details

Description

Tools useful when creating R packages, particularly for checking the documentation produced by roxygen2 and for adding support for the documentation of S4 methods, but also for checking some aspects of the coding style. Further, some functions of use when coding a package and others of use in interactive R sessions. Finally, R syntax highlighting for some text editors.

Details

The package contains the following non-standard subdirectories:

auxiliary

Contains scripts in other programming languages that are called by some functions of this package. Some functionality of the docu.R script needs them.

highlighting

Patterns for highlighting R syntax for use with some text editors. See the files themselves for details.

scripts

Rscript scripts for non-interactive use of R. The one used to create, check and modify package documentation is docu.R. The other scripts have no connection to creating packages but might also be useful. See the help messages of these scripts (obtained via the ‘–help’ switch) for details. The scripts are expected to run at least on UNIX-like operating systems. Windows users might need to install Rtools, see https://cran.r-project.org/bin/windows/Rtools/.


pkgutils documentation built on May 2, 2019, 5:49 p.m.