Package 'PacketLLM' reference manual

Package 'PacketLLM'

Title:	Interactive 'OpenAI' Model Integration in 'RStudio'
Description:	Offers an interactive 'RStudio' gadget interface for communicating with 'OpenAI' large language models (e.g., 'gpt-5', 'gpt-5-mini', 'gpt-5-nano') (<https://platform.openai.com/docs/api-reference>). Enables users to conduct multiple chat conversations simultaneously in separate tabs. Supports uploading local files (R, PDF, DOCX) to provide context for the models. Allows per-conversation configuration of system messages (where supported by the model). API interactions via the 'httr' package are performed asynchronously using 'promises' and 'future' to avoid blocking the R console. Useful for tasks like code generation, text summarization, and document analysis directly within the 'RStudio' environment. Requires an 'OpenAI' API key set as an environment variable.
Authors:	Antoni Czolgowski [aut, cre]
Maintainer:	Antoni Czolgowski <[email protected]>
License:	MIT + file LICENSE
Version:	0.1.1
Built:	2026-05-22 18:53:53 UTC
Source:	https://github.com/antoniczolgowski/packetllm

Title:

Interactive 'OpenAI' Model Integration in 'RStudio'

Description:

Offers an interactive 'RStudio' gadget interface for communicating with 'OpenAI' large language models (e.g., 'gpt-5', 'gpt-5-mini', 'gpt-5-nano') (<https://platform.openai.com/docs/api-reference>). Enables users to conduct multiple chat conversations simultaneously in separate tabs. Supports uploading local files (R, PDF, DOCX) to provide context for the models. Allows per-conversation configuration of system messages (where supported by the model). API interactions via the 'httr' package are performed asynchronously using 'promises' and 'future' to avoid blocking the R console. Useful for tasks like code generation, text summarization, and document analysis directly within the 'RStudio' environment. Requires an 'OpenAI' API key set as an environment variable.

Authors:

Antoni Czolgowski [aut, cre]

Maintainer:

Antoni Czolgowski <[email protected]>

License:

MIT + file LICENSE

Version:

0.1.1

Built:

2026-05-22 18:53:53 UTC

Source:

https://github.com/antoniczolgowski/packetllm

Help Index

Add attachment to active conversation

Description

Add attachment to active conversation

Usage

add_attachment_to_active_conversation(name, content)
add_attachment_to_active_conversation(name, content)

Arguments

name

File name.

content

File content as string.

Value

Logical.

Add a message to the active conversation

Description

Locks the model on the first assistant message. Sets title on the first user message.

Usage

add_message_to_active_history(role, content)
add_message_to_active_history(role, content)

Arguments

role

'user'|'assistant'|'system'

content

Message content

Value

Result list (type + extra fields) or error list.

Add user message to the active conversation

Description

Add user message to the active conversation

Usage

add_user_message(text)
add_user_message(text)

Arguments

text

Single character string.

Value

Invisible NULL.

List of available OpenAI models for selection in the UI

Description

List of available OpenAI models for selection in the UI

Usage

available_openai_models
available_openai_models

Format

An object of class character of length 3.

Call OpenAI API

Description

Sends messages to the OpenAI Chat Completions API and returns the assistant content. Temperature is not sent; models run with API defaults.

Usage

call_openai_chat(messages, model)
call_openai_chat(messages, model)

Arguments

messages

List of messages (each a list with 'role' and 'content').

model

OpenAI model to use.

Value

Character string with assistant reply, or NULL on unexpected response.

Examples

## Not run: 
  msgs <- list(
    list(role = "system", content = "You are concise."),
    list(role = "user", content = "What does httr do?")
  )
  call_openai_chat(messages = msgs, model = "gpt-5-mini")

## End(Not run)
## Not run: 
  msgs <- list(
    list(role = "system", content = "You are concise."),
    list(role = "user", content = "What does httr do?")
  )
  call_openai_chat(messages = msgs, model = "gpt-5-mini")

## End(Not run)

Check API Key

Description

Verifies that OPENAI_API_KEY is set. Stops if missing.

Usage

check_api_key()
check_api_key()

Value

Invisible TRUE if set.

Examples

## Not run: 
  check_api_key()

## End(Not run)
## Not run: 
  check_api_key()

## End(Not run)

Create a new conversation

Description

Create a new conversation

Usage

create_new_conversation(
  activate = FALSE,
  add_initial_settings = TRUE,
  title = NULL
)
create_new_conversation(
  activate = FALSE,
  add_initial_settings = TRUE,
  title = NULL
)

Arguments

activate

Logical. Activate immediately?

add_initial_settings

Logical. Add default model and system message?

title

Optional title; if NULL, a time-based title is used.

Value

Character: conversation ID.

Delete a conversation

Description

Delete a conversation

Usage

delete_conversation(id)
delete_conversation(id)

Arguments

id

get_conversation_attachments(id)
get_conversation_attachments(id)

Arguments

id

Conversation ID.

Value

List or NULL.

Get conversation data by ID

Description

Get conversation data by ID

Usage

get_conversation_data(id)
get_conversation_data(id)

Arguments

id

Conversation ID.

Value

List or NULL.

Get conversation history by ID

Description

Get conversation history by ID

Usage

get_conversation_history(id)
get_conversation_history(id)

Arguments

id

Conversation ID.

Value

List or NULL.

Get model for conversation

Description

Get model for conversation

Usage

get_conversation_model(id)
get_conversation_model(id)

Arguments

id

Conversation ID.

Value

Character or NULL.

Get conversation title by ID

Description

Get conversation title by ID

Usage

get_conversation_title(id)
get_conversation_title(id)

Arguments

id

Conversation ID.

Value

Character or NULL.

Initialize the history manager

Description

Clears state and creates a single new conversation, then activates it.

Usage

initialize_history_manager()
initialize_history_manager()

Value

Character: ID of the created conversation.

Has the conversation started (model locked)?

Description

Has the conversation started (model locked)?

Usage

is_conversation_started(id)
is_conversation_started(id)

Arguments

id

Conversation ID.

Value

Logical.

Parse page range

Description

This function processes a character string specifying a page range (e.g., "1-3,5") and returns a numeric vector containing the individual page numbers, sorted and unique.

Usage

parse_pages(pages_str)
parse_pages(pages_str)

Arguments

pages_str

Character string specifying pages, e.g., "1-3,5".

Value

A numeric vector containing the unique page numbers specified in the input string, sorted in ascending order. Returns an empty integer vector if the input string is empty or contains only whitespace. Stops with an error if the input pages_str is not a single character string or if the format within the string is invalid (e.g., non-numeric parts, invalid ranges).

Examples

# Example 1: Simple range and single page
page_string1 <- "1-3, 5"
parsed_pages1 <- parse_pages(page_string1)
print(parsed_pages1) # Output: [1] 1 2 3 5

# Example 2: Multiple ranges and single pages, with spaces and duplicates
page_string2 <- " 2, 4-6, 9 , 11-12, 5 "
parsed_pages2 <- parse_pages(page_string2)
print(parsed_pages2) # Output: [1] 2 4 5 6 9 11 12 (sorted, unique)

# Example 3: Single number
page_string3 <- "10"
parsed_pages3 <- parse_pages(page_string3)
print(parsed_pages3) # Output: [1] 10

# Example 4: Empty string input
page_string_empty <- ""
parsed_pages_empty <- parse_pages(page_string_empty)
print(parsed_pages_empty) # Output: integer(0)

# Example 5: Invalid input (non-numeric) - demonstrates error handling
page_string_invalid <- "1-3, five"
## Not run: 
# This will stop with an error message about "five"
tryCatch(parse_pages(page_string_invalid), error = function(e) print(e$message))

## End(Not run)

# Example 6: Invalid range format (missing end) - demonstrates error handling
page_string_invalid_range <- "1-"
## Not run: 
# This will stop with an error message about invalid range format
tryCatch(parse_pages(page_string_invalid_range), error = function(e) print(e$message))

## End(Not run)

# Example 7: Invalid range format (start > end) - demonstrates error handling
page_string_invalid_order <- "5-3"
## Not run: 
# This will stop with an error message about invalid range values
tryCatch(parse_pages(page_string_invalid_order), error = function(e) print(e$message))

## End(Not run)
# Example 1: Simple range and single page
page_string1 <- "1-3, 5"
parsed_pages1 <- parse_pages(page_string1)
print(parsed_pages1) # Output: [1] 1 2 3 5

# Example 2: Multiple ranges and single pages, with spaces and duplicates
page_string2 <- " 2, 4-6, 9 , 11-12, 5 "
parsed_pages2 <- parse_pages(page_string2)
print(parsed_pages2) # Output: [1] 2 4 5 6 9 11 12 (sorted, unique)

# Example 3: Single number
page_string3 <- "10"
parsed_pages3 <- parse_pages(page_string3)
print(parsed_pages3) # Output: [1] 10

# Example 4: Empty string input
page_string_empty <- ""
parsed_pages_empty <- parse_pages(page_string_empty)
print(parsed_pages_empty) # Output: integer(0)

# Example 5: Invalid input (non-numeric) - demonstrates error handling
page_string_invalid <- "1-3, five"
## Not run: 
# This will stop with an error message about "five"
tryCatch(parse_pages(page_string_invalid), error = function(e) print(e$message))

## End(Not run)

# Example 6: Invalid range format (missing end) - demonstrates error handling
page_string_invalid_range <- "1-"
## Not run: 
# This will stop with an error message about invalid range format
tryCatch(parse_pages(page_string_invalid_range), error = function(e) print(e$message))

## End(Not run)

# Example 7: Invalid range format (start > end) - demonstrates error handling
page_string_invalid_order <- "5-3"
## Not run: 
# This will stop with an error message about invalid range values
tryCatch(parse_pages(page_string_invalid_order), error = function(e) print(e$message))

## End(Not run)

Read file content

Description

This function reads the content of a file with the extension .R, .pdf, or .docx and returns it as a single character string. TXT files are also supported. For PDF files, if the pages parameter is provided, only the selected pages will be read.

Usage

read_file_content(file_path, pages = NULL)
read_file_content(file_path, pages = NULL)

Arguments

file_path

Character string. Path to the file.

pages

Optional. A numeric vector specifying which pages (for PDF) should be read.

Value

A character string containing the file content, with pages separated by double newlines for PDF files. Stops with an error if the file does not exist, the format is unsupported, or required packages (pdftools for PDF, readtext for DOCX) are not installed or if pages is not numeric when provided.

Examples

# --- Example for reading an R file ---
# Create a temporary R file
temp_r_file <- tempfile(fileext = ".R")
writeLines(c("x <- 1", "print(x + 1)"), temp_r_file)

# Read the content
r_content <- tryCatch(read_file_content(temp_r_file), error = function(e) e$message)
print(r_content)

# Clean up the temporary file
unlink(temp_r_file)

# --- Example for reading a TXT file ---
temp_txt_file <- tempfile(fileext = ".txt")
writeLines(c("Line one.", "Second line."), temp_txt_file)
txt_content <- tryCatch(read_file_content(temp_txt_file), error = function(e) e$message)
print(txt_content)
unlink(temp_txt_file)

# --- Example for PDF (requires pdftools, only run if installed) ---
## Not run: 
# This part requires the 'pdftools' package and a valid PDF file.
# Provide a path to an actual PDF file to test this functionality.
# Replace "path/to/your/sample.pdf" with a real path.

pdf_file_path <- "path/to/your/sample.pdf"

# Check if pdftools is installed and the file exists
if (requireNamespace("pdftools", quietly = TRUE) && file.exists(pdf_file_path)) {

  # Example: Read all pages
  pdf_content_all <- tryCatch(
    read_file_content(pdf_file_path),
    error = function(e) paste("Error reading all pages:", e$message)
  )
  # print(substr(pdf_content_all, 1, 100)) # Print first 100 chars

  # Example: Read only page 1
  pdf_content_page1 <- tryCatch(
    read_file_content(pdf_file_path, pages = 1),
    error = function(e) paste("Error reading page 1:", e$message)
  )
  # print(pdf_content_page1)

} else if (!requireNamespace("pdftools", quietly = TRUE)) {
  message("Skipping PDF example: 'pdftools' package not installed.")
} else {
  message("Skipping PDF example: File not found at '", pdf_file_path, "'")
}

## End(Not run)
# Note: Reading DOCX files is also supported if the 'readtext' package
# is installed, but a simple runnable example is difficult to create
# without including a sample file or complex setup.
# --- Example for reading an R file ---
# Create a temporary R file
temp_r_file <- tempfile(fileext = ".R")
writeLines(c("x <- 1", "print(x + 1)"), temp_r_file)

# Read the content
r_content <- tryCatch(read_file_content(temp_r_file), error = function(e) e$message)
print(r_content)

# Clean up the temporary file
unlink(temp_r_file)

# --- Example for reading a TXT file ---
temp_txt_file <- tempfile(fileext = ".txt")
writeLines(c("Line one.", "Second line."), temp_txt_file)
txt_content <- tryCatch(read_file_content(temp_txt_file), error = function(e) e$message)
print(txt_content)
unlink(temp_txt_file)

# --- Example for PDF (requires pdftools, only run if installed) ---
## Not run: 
# This part requires the 'pdftools' package and a valid PDF file.
# Provide a path to an actual PDF file to test this functionality.
# Replace "path/to/your/sample.pdf" with a real path.

pdf_file_path <- "path/to/your/sample.pdf"

# Check if pdftools is installed and the file exists
if (requireNamespace("pdftools", quietly = TRUE) && file.exists(pdf_file_path)) {

  # Example: Read all pages
  pdf_content_all <- tryCatch(
    read_file_content(pdf_file_path),
    error = function(e) paste("Error reading all pages:", e$message)
  )
  # print(substr(pdf_content_all, 1, 100)) # Print first 100 chars

  # Example: Read only page 1
  pdf_content_page1 <- tryCatch(
    read_file_content(pdf_file_path, pages = 1),
    error = function(e) paste("Error reading page 1:", e$message)
  )
  # print(pdf_content_page1)

} else if (!requireNamespace("pdftools", quietly = TRUE)) {
  message("Skipping PDF example: 'pdftools' package not installed.")
} else {
  message("Skipping PDF example: File not found at '", pdf_file_path, "'")
}

## End(Not run)
# Note: Reading DOCX files is also supported if the 'readtext' package
# is installed, but a simple runnable example is difficult to create
# without including a sample file or complex setup.

Reset the history manager

Description

Reset the history manager

Usage

reset_history_manager()
reset_history_manager()

Value

Invisible NULL.

Run the LLM Chat Application in RStudio Window

Description

Launches the Shiny application as a Gadget in the RStudio Viewer pane (or a separate window). Interacts with LLM models, managing conversations, attachments, and settings, without blocking the R console when opened in a new window.

Usage

run_llm_chat_app()
run_llm_chat_app()

Value

Value passed to shiny::stopApp() (typically NULL).

Examples

## Not run: 
run_llm_chat_app()

## End(Not run)
## Not run: 
run_llm_chat_app()

## End(Not run)

Set the active conversation

Description

Set the active conversation

Usage

set_active_conversation(id)
set_active_conversation(id)

Arguments

id

Conversation ID or NULL.

Value

Invisible NULL.

Set model for conversation (if not started)

Description

Set model for conversation (if not started)

Usage

set_conversation_model(id, model_name)
set_conversation_model(id, model_name)

Arguments

id

Conversation ID.

model_name

Model name (must be in available_openai_models).

Value

Logical.

Set system message for conversation

Description

Set system message for conversation

Usage

set_conversation_system_message(id, message)
set_conversation_system_message(id, message)

Arguments

id

Conversation ID.

message

Single string system message.

Value

Logical.