set_positron_settings: Configure Positron Settings

In tutorial.helpers: Helper Functions for Creating Tutorials

Configure Positron Settings

Description

Locates or creates the Positron settings.json file on Windows or macOS, then updates those settings based on the provided configuration list. Users can specify settings like RStudio keyboard shortcuts. The function can also optionally configure binary package preferences in the .Rprofile.

Usage

set_positron_settings(
  home_dir = path.expand("~"),
  set.binary = TRUE,
  positron_settings = list()
)

Arguments

home_dir	Optional character string specifying the base directory to use as the user's home directory. Defaults to path.expand("~"). Useful for testing or custom setups.
set.binary	Logical, defaults to TRUE. If TRUE, runs set_binary_only_in_r_profile() after applying settings to configure binary options in the R profile.
positron_settings	List of settings to apply. Can be structured as a list of lists where each sub-list contains a setting name and value (e.g., list(list("rstudio.keymap.enable", TRUE))), or as a named list (e.g., list("rstudio.keymap.enable" = TRUE)). Defaults to an empty list, which means no settings will be changed.

Details

This function uses the jsonlite package to handle JSON operations and creates the necessary directory structure if it doesn't exist. It is designed to work cross-platform by detecting the operating system and constructing the appropriate file path to Positron's user settings. The function applies the settings provided in the positron_settings parameter. By default, no settings are changed unless explicitly specified.

Value

Invisible NULL. The function's purpose is its side effect: modifying or creating the settings.json file. It also prints messages to the console indicating actions taken.

Examples

## Not run: 
  # Apply no settings changes, but ensure settings.json exists
  set_positron_settings()
  
  # Enable RStudio keyboard shortcuts using list of lists structure
  set_positron_settings(
    positron_settings = list(list("rstudio.keymap.enable", TRUE))
  )
  
  # Enable RStudio keyboard shortcuts using named list structure
  set_positron_settings(
    positron_settings = list("rstudio.keymap.enable" = TRUE)
  )
  
  # Apply multiple settings using named list
  set_positron_settings(
    positron_settings = list(
      "rstudio.keymap.enable" = TRUE,
      "editor.wordWrap" = "on"
    )
  )
  
  # Apply settings with a custom home directory and disable binary setting
  set_positron_settings(
    home_dir = tempdir(), 
    set.binary = FALSE,
    positron_settings = list("rstudio.keymap.enable" = TRUE)
  )

## End(Not run)

tutorial.helpers documentation built on June 8, 2025, 1:26 p.m.