listDocArgs: Get all the arguments from the Rd files

In bozenne/butils.base: Tools to source R code or install R packages

Get all the arguments from the Rd files

Description

Create a file in inst containing the description of all the arguments from the Rd file of a package

Usage

listDocArgs(dir, trace = TRUE)

Arguments

dir	the path to the directory containing the R package
trace	should the execution of the function be traced

Value

a list containing:

• argByFunction name of the arguments of the functions/methods that are documented.

• docByFunction description of the arguments of the functions/methods that are documented.

• functionNames name of the functions/methods that are documented.

• dfAll data.frame object gathering function names, argument names, and description of the arguments

Examples

## Not run: 
res <- listDocArgs(file.path(pathGitHub(),"butils.base"))
res$functionNames
res$argByFunction

## End(Not run)

bozenne/butils.base documentation built on May 13, 2024, 12:20 p.m.