Skip to contents

Perform a spell check on notebooks with spelling::spell_check_files().

Usage

spell_check_notebooks(
  path = "analysis",
  regexp = "[.][Rq]md$",
  use_wordlist = TRUE,
  lang = NULL
)

Arguments

path

A character vector of one or more paths.

regexp

A regular expression (e.g. [.]csv$) passed on to grep() to filter paths.

use_wordlist

ignore words in the package WORDLIST file.

lang

set Language field in DESCRIPTION e.g. "en-US" or "en-GB". For supporting other languages, see the hunspell vignette.

Details

If lang is NULL (the default), get language from DESCRIPTION using desc::desc_get_field().