Helper functions using {sinew} to make roxygen2 skeletons for directories, files, and objects

These functions are wrappers for sinew::makeOxyFile() and sinew::makeOxygen().

Usage

dir_roxy(path, markdown = TRUE, quiet = FALSE, ...)

file_roxy(path, markdown = TRUE, quiet = FALSE, ...)

obj_roxy(obj, title = NULL, description = NULL, markdown = TRUE, ...)

Arguments

path

File or directory path.

markdown

boolean to return roxygen2 skeleton with Markdown formatting, Default: FALSE

quiet

If FALSE (default), open code files generated by sinew::makeOxyFile() or print code generated by sinew::makeOxygen().

...

Arguments passed on to makeOxygen

add_default

boolean to add defaults values to the end of the PARAM fields, Default: TRUE

add_fields

character vector to add additional roxygen2 fields, Default: c("details","examples","seealso","rdname","export")

use_dictionary

character, path_to_dictionary, Default: NULL

use_labels

boolean to use label attribute of data frame columns to fill column description values. Ignored if obj is a function or vector. Default: FALSE.

scope

The scope of transformations: "simple" runs only transformations that shouldn't substantially change the resulting .Rd files, "full" runs all transformations. In larger packages, run "none", double-check and track the changes, and then run "simple" and then "full".

obj

function or name of function, a data frame, or a vector (strings are interpreted as function names).

title, description

Optional title and description values to use

See also

sinew::makeOxyFile()