Title: AI Copilot for R Analysis Workflows in 'RStudio'
Version: 0.1.1
Description: An AI copilot for R users in 'RStudio' and Posit workflows with active-editor, workspace, object, console, plot, and git-aware context. Provides statistical helpers for interpreting lm() and glm() models, stages code and file actions before execution, drafts reproducible 'Quarto' content, and connects to official provider APIs or CLIs for 'OpenAI', 'GitHub Copilot', 'Gemini', and 'Anthropic'.
License: MIT + file LICENSE
URL: https://github.com/msaule/ravel, https://msaule.github.io/ravel/
BugReports: https://github.com/msaule/ravel/issues
Language: en-US
Encoding: UTF-8
RoxygenNote: 7.3.3
Depends: R (≥ 4.2.0)
Imports: cli, digest, httr2, jsonlite, miniUI, rstudioapi, shiny, stats, tibble, tools, utils
Suggests: keyring, knitr, lintr, pkgdown, rcmdcheck, rmarkdown, testthat (≥ 3.0.0)
VignetteBuilder: knitr
Config/testthat/edition: 3
Config/Needs/website: pkgdown
Config/Needs/release: devtools, rcmdcheck, roxygen2
NeedsCompilation: no
Packaged: 2026-03-31 15:56:01 UTC; saule
Author: Markuss Saule [aut, cre, cph]
Maintainer: Markuss Saule <markusstomas@gmail.com>
Repository: CRAN
Date/Publication: 2026-04-03 20:30:02 UTC

Ravel

Description

Ravel is an RStudio-native coding and analytics copilot for R users.

Author(s)

Maintainer: Markuss Saule markusstomas@gmail.com [copyright holder]

See Also

Useful links:

Execute a staged action

Description

Execute a staged action

Usage

ravel_apply_action(action, approve = FALSE, envir = NULL)

Arguments

action

A ravel_action.

approve

Whether to override and treat the action as approved.

envir

Evaluation environment for code execution. When NULL, Ravel uses a dedicated session-scoped environment that inherits from globalenv() for reads without writing into .GlobalEnv by default.

Value

A structured result list.

Approve a staged action

Description

Approve a staged action

Usage

ravel_approve_action(action)

Arguments

action

A ravel_action.

Value

The updated action.

Report provider auth status

Description

Report provider auth status

Usage

ravel_auth_status(provider = c("openai", "copilot", "gemini", "anthropic"))

Arguments

provider

Provider name.

Value

A named list describing auth configuration.

Launch the Ravel chat addin

Description

Launch the Ravel chat addin

Usage

ravel_chat_addin()

Value

Invisibly launches a Shiny gadget.

Run one chat turn through a provider

Description

Run one chat turn through a provider

Usage

ravel_chat_turn(
  prompt,
  provider = NULL,
  model = NULL,
  context = NULL,
  history = NULL
)

Arguments

prompt

User prompt.

provider

Provider name.

model

Optional model override.

context

Optional precomputed context.

history

Optional existing chat history.

Value

A list with message, actions, and raw.

Collect context for a Ravel chat turn

Description

Collect context for a Ravel chat turn

Usage

ravel_collect_context(
  include_selection = TRUE,
  include_file = TRUE,
  include_objects = TRUE,
  include_console = TRUE,
  include_plot = TRUE,
  include_session = TRUE,
  include_project = TRUE,
  include_git = TRUE,
  include_activity = TRUE,
  envir = NULL,
  max_objects = 10L
)

Arguments

include_selection

Include the active selection.

include_file

Include the active file contents.

include_objects

Include summaries of loaded objects.

include_console

Include recent Ravel-managed console output.

include_plot

Include current plot metadata when available.

include_session

Include session information.

include_project

Include project root and file listing.

include_git

Include git status and diff summaries when available.

include_activity

Include recent Ravel action state.

envir

Environment used for object summaries. When NULL, Ravel reads from the current global workspace without modifying it.

max_objects

Maximum number of objects to summarize.

Value

A named list.

Inspect local Ravel readiness

Description

Inspect local Ravel readiness

Usage

ravel_doctor()

Value

A tibble of system and provider checks with suggested fixes.

Draft a Quarto section from analysis context

Description

Draft a Quarto section from analysis context

Usage

ravel_draft_quarto_section(
  section = c("results", "methods", "diagnostics"),
  model = NULL,
  context = NULL,
  include_chunk = TRUE
)

Arguments

section

Section type.

model

Optional fitted model object.

context

Optional collected context.

include_chunk

Whether to include a placeholder code chunk.

Value

A character string containing Quarto markdown.

Get a Ravel setting

Description

Get a Ravel setting

Usage

ravel_get_setting(key, default = NULL)

Arguments

key

Setting name.

default

Default value when the setting is missing.

Value

The setting value.

Interpret a model in plain English

Description

Interpret a model in plain English

Usage

ravel_interpret_model(model)

Arguments

model

A fitted model object.

Value

A character string.

Launch an official provider login flow

Description

Launch an official provider login flow

Usage

ravel_launch_login(
  provider = c("openai", "copilot", "gemini", "anthropic"),
  mode = NULL
)

Arguments

provider

Provider name.

mode

Optional auth mode override.

Value

A login plan list, invisibly.

List project files for context gathering

Description

List project files for context gathering

Usage

ravel_list_project_files(root = NULL, limit = 200L)

Arguments

root

Optional project root.

limit

Maximum number of file paths to return.

Value

A character vector of relative paths.

List configured providers

Description

List configured providers

Usage

ravel_list_providers()

Value

A tibble describing the available provider adapters.

Start a provider login flow

Description

Start a provider login flow

Usage

ravel_login(
  provider = c("openai", "copilot", "gemini", "anthropic"),
  mode = NULL
)

Arguments

provider

Provider name.

mode

Optional auth mode override.

Value

A list describing the supported login action.

Logout a provider from Ravel-managed credentials

Description

Logout a provider from Ravel-managed credentials

Usage

ravel_logout(provider = c("openai", "copilot", "gemini", "anthropic"))

Arguments

provider

Provider name.

Value

Invisibly TRUE.

Create a new staged Ravel action

Description

Create a new staged Ravel action

Usage

ravel_new_action(type, label, payload, provider = NULL, model = NULL)

Arguments

type

Action type.

label

Human-readable label.

payload

Action payload.

provider

Optional provider name.

model

Optional model name.

Value

A ravel_action object.

Open an official provider documentation or key-management page

Description

Open an official provider documentation or key-management page

Usage

ravel_open_provider_page(
  provider = c("openai", "copilot", "gemini", "anthropic"),
  page = c("docs", "api_keys")
)

Arguments

provider

Provider name.

page

Which page to open.

Value

The opened URL, invisibly.

Preview generated code as a staged action

Description

Preview generated code as a staged action

Usage

ravel_preview_code(
  code,
  label = "Run generated R code",
  provider = NULL,
  model = NULL
)

Arguments

code

R code text.

label

Label for the staged action.

provider

Optional provider name.

model

Optional model name.

Value

A ravel_action object.

Report provider capabilities

Description

Report provider capabilities

Usage

ravel_provider_capabilities(
  provider = c("openai", "copilot", "gemini", "anthropic")
)

Arguments

provider

Provider name.

Value

A named list.

Read recent Ravel history entries

Description

Read recent Ravel history entries

Usage

ravel_read_history(limit = 100L)

Arguments

limit

Maximum number of history entries to return.

Details

History stays in session memory by default. To mirror it to disk explicitly, configure options(ravel.user_dirs = list(data = "<path>")).

Value

A tibble.

Reject a staged action

Description

Reject a staged action

Usage

ravel_reject_action(action)

Arguments

action

A ravel_action.

Value

The updated action.

Run R code with explicit approval semantics

Description

Run R code with explicit approval semantics

Usage

ravel_run_code(action, approve = FALSE, envir = NULL)

Arguments

action

Either a ravel_action or a character string of R code.

approve

Whether to approve and run immediately.

envir

Evaluation environment. When NULL, code runs in Ravel's dedicated session-scoped execution environment instead of .GlobalEnv.

Value

A structured result list.

Store an API key for a provider

Description

Store an API key for a provider

Usage

ravel_set_api_key(
  provider = c("openai", "gemini", "anthropic"),
  key,
  persist = TRUE
)

Arguments

provider

Provider name.

key

API key value.

persist

Whether to try to persist the secret using keyring.

Value

The stored key, invisibly.

Store a bearer token for a provider

Description

Store a bearer token for a provider

Usage

ravel_set_bearer_token(provider = c("gemini"), token, persist = TRUE)

Arguments

provider

Provider name.

token

Bearer token value.

persist

Whether to try to persist the token using keyring.

Value

The stored token, invisibly.

Set a Ravel setting

Description

Set a Ravel setting

Usage

ravel_set_setting(key, value)

Arguments

key

Setting name.

value

Setting value.

Details

Settings are stored in session memory by default. To mirror non-sensitive settings to disk explicitly, configure options(ravel.user_dirs = list( config = "<path>")) before calling this function.

Value

The written settings list, invisibly.

Launch the Ravel settings addin

Description

Launch the Ravel settings addin

Usage

ravel_settings_addin()

Value

Invisibly launches a Shiny gadget.

Launch the Ravel setup assistant

Description

Launch the Ravel setup assistant

Usage

ravel_setup_addin()

Value

Invisibly launches a Shiny gadget.

Stage a file write action

Description

Stage a file write action

Usage

ravel_stage_file_write(
  path,
  text,
  append = FALSE,
  provider = NULL,
  model = NULL
)

Arguments

path

Target file path.

text

Text to write.

append

Whether to append instead of overwrite.

provider

Optional provider name.

model

Optional model name.

Value

A ravel_action object.

Suggest diagnostics for a model

Description

Suggest diagnostics for a model

Usage

ravel_suggest_diagnostics(model)

Arguments

model

A fitted model object.

Value

A character vector of suggested checks.

Summarize a model object

Description

Summarize a model object

Usage

ravel_summarize_model(model, name = NULL)

Arguments

model

A fitted model object.

name

Optional object name.

Value

A named list with model metadata and coefficient summaries.

Summarize an R object for provider context

Description

Summarize an R object for provider context

Usage

ravel_summarize_object(x, name = NULL)

Arguments

x

An R object.

name

Optional object name.

Value

A named list.

Verify a provider with a tiny live prompt

Description

Verify a provider with a tiny live prompt

Usage

ravel_verify_provider(
  provider = c("openai", "copilot", "gemini", "anthropic"),
  model = NULL
)

Arguments

provider

Provider name.

model

Optional model override.

Value

A named list with ok, content, provider, and model.