gen_docs: Generate Roxygen Documentation
In gemini.R: Interface for 'Google Gemini' API
gen_docs R Documentation
Generate Roxygen Documentation
Description
Generates Roxygen2 documentation for an R function based on the currently selected code.
Usage
gen_docs(prompt = NULL)
Arguments
prompt
A character string specifying additional instructions for the LLM. Defaults to a prompt requesting Roxygen2 documentation without the original code.
Value
A character string containing the generated Roxygen2 documentation.
gemini.R documentation built on April 11, 2025, 6:11 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.
| gen_docs | R Documentation |
Generate Roxygen Documentation
Description
Generates Roxygen2 documentation for an R function based on the currently selected code.
Usage
gen_docs(prompt = NULL)
Arguments
prompt |
A character string specifying additional instructions for the LLM. Defaults to a prompt requesting Roxygen2 documentation without the original code. |
Value
A character string containing the generated Roxygen2 documentation.
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.