Generate PUT Annotation Comments

Analyzes source code files and generates suggested PUT annotation comments based on detected inputs, outputs, and dependencies. This is similar to how roxygen2 generates documentation skeletons.

Usage

put_generate(
  path,
  pattern = NULL,
  recursive = TRUE,
  output = "console",
  insert = FALSE,
  style = "multiline",
  exclude = NULL,
  log_level = NULL
)

Arguments

path

Character string specifying the path to a file or directory

pattern

Character string specifying the file pattern to match. Default: all extensions with detection pattern support.

recursive

Logical. Should subdirectories be searched recursively? Default: TRUE

output

Character string specifying output destination:

• "console" - Print to console (default)

• "raw" - Return as string without printing

• "clipboard" - Copy to clipboard (requires clipr package)

• "file" - Write to files with .put suffix

insert

Logical. If TRUE, insert annotations directly into source files at the top. Use with caution. Default: FALSE

style

Character string specifying annotation style:

• "single" - Single-line annotations

• "multiline" - Multiline annotations with backslash continuation

Default: "multiline"

exclude

Character vector of regex patterns. Files whose full path matches any pattern are excluded. Default: NULL (no exclusion).

log_level

Character string specifying log verbosity for this call. Overrides the global option putior.log_level when specified. Options: "DEBUG", "INFO", "WARN", "ERROR". See set_putior_log_level.

Value

Invisibly returns a character vector of generated annotations. Side effects depend on the output parameter.

See also

put_auto for direct workflow detection, put for extracting existing annotations

Examples

if (FALSE) { # \dontrun{
# Print suggested annotations to console
put_generate("./analysis.R")

# Copy to clipboard for easy pasting
put_generate("./scripts/", output = "clipboard")

# Generate multiline style annotations
put_generate("./src/", style = "multiline")

# Insert annotations directly into files (use with caution)
put_generate("./new_script.R", insert = TRUE)
} # }