package.skeleton.dx {inlinedocs}R Documentation

Package skeleton deluxe

Description

Automates more of the setup process for a new source package. After inspecting the specified R code files to find inline documentation, it calls the standard package.skeleton function, which creates bare Rd files. The inline documentation is added to these Rd files and then these files are copied to ../man. It will overwrite files in the pkgdir/man directory.

Usage

package.skeleton.dx(pkgdir = "..", code_files = NULL, check = "")

Arguments

pkgdir package directory where the DESCRIPTION file lives. Your code should be in pkgdir/R. We will setwd to pkgdir/R for the duration of the function, then switch back to where you were previously.
code_files Character vector with the names of the R code files, to be passed to package.skeleton, and also inspected for inline documentation. NULL means all files ending in .R.
check Value indicating whether or not to check the package after documentation is built. Anything other than "" (the default) will check the package. "noex" means check the package without running examples, only tests (useful for debugging if your tests/examples take a long time).

Author(s)

Toby Dylan Hocking <toby.hocking@etu.upmc.fr>


[Package inlinedocs version 1.0 Index]