tif_is_corpus_character: Validate Corpus Character Vector Object

In ropensci/tif: Text Interchange Format

Validate Corpus Character Vector Object

Description

A valid character vector corpus object is an character vector with UTF-8 encoding. If it has names, this should be a unique character also in UTF-8 encoding. No other attributes should be present.

Usage

tif_is_corpus_character(corpus, warn = FALSE)

Arguments

corpus	a corpus object to test for validity
warn	logical. Should the function produce a verbose warning for the condition for which the validation fails. Useful for testing.

Details

The tests are run sequentially and the function returns, with a warning if the warn flag is set, on the first test that fails. We use this implementation because some tests may fail entirely or be meaningless if the prior ones are note passed.

Value

a logical vector of length one indicating whether the input is a valid corpus

Examples

corpus <- c("Aujourd'hui, maman est morte.",
            "It was a pleasure to burn.",
            "All this happened, more or less.")

tif_is_corpus_character(corpus)

names(corpus) <- c("Camus", "Bradbury", "Vonnegut")
tif_is_corpus_character(corpus)

ropensci/tif documentation built on Nov. 30, 2023, 7:46 p.m.