add_roxygen: Add Roxygen2 documentation to an R function
In TheOpenAIR: Integrate 'OpenAI' Large Language Models into Your 'R' Workflows
add_roxygen R Documentation
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 umatter@protonmail.com
TheOpenAIR documentation built on April 27, 2023, 5:10 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| add_roxygen | R Documentation |
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 umatter@protonmail.com
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.