spell: RMarkdown Spell Check

In exams.forge: Support for Compiling Examination Tasks using the 'exams' Package

RMarkdown Spell Check

Description

Performs a spell check on RMarkdown files ignoring some exams keywords using spelling::spell_check_files().

Usage

spell(
  path,
  ignore = c("Meta", "information", "extype", "num", "mchoice", "schoice", "Solution",
    "exsolution", "extol", "exname", "Question", "align", "begin", "bigg", "cases",
    "cdot", "end", "frac", "infty", "int", "left", "left.", "leq", "mu", "qquad",
    "right", "sum", "text", "vert"),
  lang = Sys.getenv("LANG")
)

rm_spell_check(
  path,
  ignore = c("Meta", "information", "extype", "num", "mchoice", "schoice", "Solution",
    "exsolution", "extol", "exname", "Question", "align", "begin", "bigg", "cases",
    "cdot", "end", "frac", "infty", "int", "left", "left.", "leq", "mu", "qquad",
    "right", "sum", "text", "vert"),
  lang = Sys.getenv("LANG")
)

Arguments

path	path to file or to spell check
ignore	character vector with words which will be added to the hunspell::dictionary
lang	set Language field in DESCRIPTION e.g. "en-US" or "en-GB". For supporting other languages, see the hunspell vignette.

Value

A data frame with problematic words.

Examples

# none

exams.forge documentation built on Sept. 11, 2024, 5:32 p.m.