Learn R
inlinedocs (version 2013.9.3)

package.skeleton.dx: Package skeleton deluxe

Description

Generates Rd files for a package based on R code and DESCRIPTION metadata. 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 pkgdir/man, possibly overwriting the previous files there.

Usage

package.skeleton.dx(pkgdir = "..", parsers = NULL, namespace = FALSE,  excludePattern = FALSE, ...)

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.
parsers
List of Parser functions, which will be applied in sequence to extract documentation from your code. Default NULL means to first search for a definition in the variable "parsers" in pkgdir/R/.inlinedocs.R, if that file exists. If not, we use the list defined in options("inlinedocs.parsers"), if that is defined. If not, we use the package global default in the variable default.parsers.
namespace
A logical indicating whether a NAMESPACE file should be generated for this package. If TRUE, all objects whose name starts with a letter, plus all S4 methods and classes are exported.
excludePattern
A regular expression matching the files that are not to be processed e.g. because inlinedocs can not handle them yet (like generic function definitions)
...
Parameters to pass to Parser Functions.

Examples

Run this code
owd <- setwd(tempdir())

## get the path to the silly example package that is provided with
## package inlinedocs
testPackagePath <- file.path(system.file(package="inlinedocs"),"silly")
## copy example project to the current unlocked workspace that can
## be modified
file.copy(testPackagePath,".",recursive=TRUE)

## generate documentation .Rd files for this package
package.skeleton.dx("silly")

## check the package to see if generated documentation passes
## without WARNINGs.
if(interactive()){
  cmd <- sprintf("%s CMD check --as-cran silly",file.path(R.home("bin"), "R"))
  print(cmd)
  checkLines <- system(cmd,intern=TRUE)
  warnLines <- grep("WARNING",checkLines,value=TRUE)
  if(length(warnLines)>0){
    writeLines(checkLines)
    cat("\n\nLines with WARNING:\n")
    print(warnLines)
    ## disable due to bug in R CMD check:
    ## https://bugs.r-project.org/bugzilla3/show_bug.cgi?id=14875
    ##stop("WARNING encountered in package check!")
  }
}  
## cleanup: remove the test package from current workspace again
unlink("silly",recursive=TRUE)
setwd(owd)

Run the code above in your browser using DataCamp Workspace