makeDictionary: Parse package R files to create dictionary of unique...

View source: R/makeDictionary.R

makeDictionaryR Documentation

Parse package R files to create dictionary of unique parameter definitions

Description

Given list of R files function returns roxygen2 template consisting of intersecting parameter definitions

Usage

makeDictionary(path, save_path = FALSE)

make_dictionary(path, save_path = FALSE)

Arguments

path

character or character vector of paths to files to parse

save_path

boolean that allows for function to write template to man-roxygen subdirectory, Default: FALSE

Value

character/character vector of intersecting parameters

Examples

## Not run: 
if(interactive()){
  makeDictionary('R')
 }

## End(Not run)

yonicd/sinew documentation built on March 1, 2024, 1:06 a.m.