ls_param: Return roxygen2 parameter calls from parameter dictionary
In sinew: Package Development Documentation and Namespace Management

ls_param

R Documentation

Return roxygen2 parameter calls from parameter dictionary

Description

Return roxygen2 parameter calls from the intersection of the parameters listed in the package dictionary and the formals of a function

Usage

ls_param(obj, dictionary = "man-roxygen/Dictionary-1.R", print = TRUE)

Arguments

`obj`	function or name of function
`dictionary`	character, path_to_dictionary, Default: 'roxygen-man/Dictionary-1.R'
`print`	boolean print output to console, Default: TRUE

Value

character vector

Examples

repo='https://raw.githubusercontent.com/yonicd/sinew/master/'
dict_loc=file.path(repo,'man-roxygen/Dictionary-1.R')
ls_param(sinew::makeOxygen,dictionary=dict_loc)

sinew documentation built on March 31, 2022, 5:06 p.m.