lang (version 0.1.0)

lang_help: Translates help documentation to another language

Description

Translates a given topic into a target language. It uses the lang argument to determine which language to translate to. If not passed, this function will look for a target language in the LANG and LANGUAGE environment variables, or if something has been passed to the .lang argument in lang_use(), to determine the target language. If the target language is English, no translation will be processed, so the help returned will be the original package's documentation.

Usage

lang_help(topic, package = NULL, lang = NULL, type = getOption("help_type"))

Value

Original or translated version of the help documentation in the output type specified

Arguments

topic

A character vector of the topic to search for.

package

The R package to look for the topic, if not provided the function will attempt to find the topic based on the loaded packages.

lang

A character vector language to translate the topic to

type

Produce "html" or "text" output for the help. It defaults to getOption("help_type")

Examples

# \donttest{
library(lang)

lang_use("ollama", "llama3.2", seed = 100)

lang_help("lang_help", lang = "spanish", type = "text")
# }