spelling: The spelling R6 class

In inbo/checklist: A Thorough and Strict Set of Checks for R Packages and Source Code

The spelling R6 class

Description

A class with the configuration for spell checking

Active bindings

default

The default language of the project.

get_md

The markdown files within the project.

get_r

The R files within the project.

get_rd

The Rd files within the project.

settings

A list with current spell checking settings.

Methods

Public methods

• spelling$new()

• spelling$print()

• spelling$set_default()

• spelling$set_exceptions()

• spelling$set_ignore()

• spelling$set_other()

• spelling$clone()

---

Method new()

Initialize a new spelling object.

Usage

spelling$new(language, base_path = ".")

Arguments

language

the default language.

base_path

the base path of the project

---

Method print()

Print the spelling object.

Usage

spelling$print(...)

Arguments

...

currently ignored.

---

Method set_default()

Define which files to ignore or to spell check in a different language.

Usage

spelling$set_default(language)

Arguments

language

The language.

---

Method set_exceptions()

Define which files to ignore or to spell check in a different language.

Usage

spelling$set_exceptions()

---

Method set_ignore()

Manually set the ignore vector. Only use this if you known what you are doing.

Usage

spelling$set_ignore(ignore)

Arguments

ignore

The character vector with ignore file patterns.

---

Method set_other()

Manually set the other list. Only use this if you known what you are doing.

Usage

spelling$set_other(other)

Arguments

other

a list with file patterns per additional language.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

spelling$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other class: checklist, citation_meta, organisation

inbo/checklist documentation built on June 15, 2025, 12:54 p.m.