add_roxygen {TheOpenAIR}

Add Roxygen2 documentation to an R function

Description

This function adds Roxygen2 documentation to an R function.

Usage

add_roxygen(file)

Arguments

file

A character string indicating the path to the file containing the R function.

Value

If the path provided is a character string, this function returns the documented function as a character string. If the input is a file path, this function returns the path of the file to which documentation was added to the file.

Author(s)

Ulrich Matter [e-mail]