Skip to contents

Downloads a dictionary from the GitLab repository. The dictionary is saved to the package's on-demand data folder for future use.

Usage

download_dictionary(
  name,
  format = c("qs2", "rda"),
  path = NULL,
  overwrite = FALSE,
  quiet = FALSE
)

Arguments

name

Dictionary name (e.g., "global_surnames").

format

File format: "qs2" (default, smaller and faster) or "rda".

path

Custom save location. If NULL, saves to the package's ondemand folder. Can be an absolute or relative path.

overwrite

Overwrite existing file if it exists? Default FALSE.

quiet

Suppress download messages? Default FALSE.

Value

Invisible NULL. The file is saved to disk.

Examples

if (FALSE) { # \dontrun{
# Download a dictionary (will prompt if file exists)
download_dictionary("global_surnames")

# Download with RDA format
download_dictionary("english_freqs", format = "rda")

# Download to custom location
download_dictionary("organisms", path = "/my/data")
} # }