goose_document: Generate R Documentation with AI

In gooseR: R Integration for 'Goose' AI

Generate R Documentation with AI

Description

Generate roxygen2 documentation for R functions.

Usage

goose_document(func, style = "roxygen2", examples = TRUE)

Arguments

func	Function object or function name
style	Character, documentation style ("roxygen2", "detailed", "minimal")
examples	Logical, whether to generate examples

Value

Character string with documentation

Examples

## Not run: 
my_func <- function(x, y, method = "pearson") {
  cor(x, y, method = method)
}

docs <- goose_document(my_func)
cat(docs)

## End(Not run)

gooseR documentation built on Feb. 6, 2026, 5:07 p.m.