chatAI4R (version 0.3.6)

addCommentCode: Add Comments to R Code

Description

This function adds comments to R code without modifying the input R code. It can either take the selected code from RStudio or read from the clipboard.

Usage

addCommentCode(
  Model = "gpt-4o-mini",
  language = "English",
  SelectedCode = TRUE
)

Value

A message indicating completion if `SelectedCode` is TRUE, otherwise the commented code is copied to the clipboard.

Arguments

Model

A character string specifying the GPT model to be used. Default is "gpt-4o-mini".

language

A character string specifying the language for the comments. Default is "English".

SelectedCode

A logical value indicating whether to use the selected code in RStudio. Default is TRUE.

Author

Satoshi Kume

Details

Add Comments to R Code

Examples

if (FALSE) {
# Option 1
# Select some text in RStudio and then run the rstudio addins
# Option 2
# Copy the text into your clipboard then execute
addCommentCode(Model = "gpt-4o-mini", language = "English", SelectedCode = TRUE)
}