Skip to contents

Lists all available dictionaries, indicating which are installed and their properties. Supports filtering by status, name pattern, and minimum row count.

Usage

list_dictionaries(
  installed_only = FALSE,
  include_core = TRUE,
  status = NULL,
  pattern = NULL,
  min_rows = NULL
)

Arguments

installed_only

If TRUE, only show dictionaries that are installed locally. Default FALSE.

include_core

If TRUE, include core dictionaries. Default TRUE.

status

Filter to a specific status: "core", "ondemand", "downloaded", or NULL (all statuses). Default NULL (all).

pattern

Regular expression to filter dictionary names. Default NULL (all).

min_rows

Minimum number of rows (filters out smaller dictionaries). Default NULL (no filter).

Value

A data frame with columns:

  • name: Dictionary name

  • status: "core", "downloaded", or "ondemand"

  • version: Dictionary version string (if available)

  • size_mb: File size in MB (if installed)

  • n_rows: Number of rows (if installed)

  • n_cols: Number of columns (if installed)

  • primary_column: Name of the primary identifier column (if available)

See also

load_dictionary for loading dictionaries, download_dictionary for pre-fetching on-demand dictionaries.

Examples

if (FALSE) { # \dontrun{
# List all dictionaries
list_dictionaries()

# List only installed dictionaries
list_dictionaries(installed_only = TRUE)

# Show only on-demand dictionaries
list_dictionaries(status = "ondemand")

# Search for English dictionaries
list_dictionaries(pattern = "^english")

# Show large dictionaries (1M+ rows)
list_dictionaries(min_rows = 1000000)

# Chained: on-demand English dictionaries
list_dictionaries(status = "ondemand", pattern = "english")
} # }