Generates Roxygen2 documentation for an R function based on the currently selected code.
Arguments
- prompt
A character string specifying additional instructions for the LLM. Defaults to a prompt requesting Roxygen2 documentation without the original code.
Value
Invisibly returns the generated documentation string, but primarily inserts the text into the RStudio console.
Examples
if (FALSE) { # \dontrun{
# Select your function code in the editor, then run:
gen_docs()
# For custom instructions:
gen_docs("Generate minimal Roxygen docs for this function")
} # }