Add ngram columns

Add ngram columns

Usage

add_ngrams(
  data,
  n = 1:2,
  feature = word,
  keep = FALSE,
  collapse = FALSE,
  by = doc_id,
  label = NULL
)

Arguments

data

A tidy data frame, potentially containing a column called "word"

n

A range defining the extent of an ngram—for instance, from word 1 to word 3. Alternatively, a single number will signal the number of words to include in each ngram. Default value of 1:2 will produce bigrams.

feature

The feature to use when constructing ngrams

keep

Whether to keep the original feature column

collapse

Whether to join the ngram parts into a single column called "ngram"

by

A grouping column identifying a document, such as doc_id

label

Whether to label variables added to data frame

Value

The original data frame with columns added for subsequent parts of ngrams

See also

Other n-gram helpers: combine_ngrams(), plot_bigrams(), separate_ngrams()

Examples

if (FALSE) { # \dontrun{
  my_corpus <- load_texts()

  my_bigrams <- my_corpus |>
    add_ngrams(3)
} # }

if (FALSE) { # \dontrun{
dubliners <- get_gutenberg_corpus(2814) |>
  load_texts() |>
  identify_by(part) |>
  standardize_titles()

dubliners |>
  add_ngrams(2) |>
  head()
} # }