unnest_tokens {tidytext} | R Documentation |
Split a column into tokens
Description
Split a column into tokens, flattening the table into one-token-per-row. This function supports non-standard evaluation through the tidyeval framework.
Usage
unnest_tokens(
tbl,
output,
input,
token = "words",
format = c("text", "man", "latex", "html", "xml"),
to_lower = TRUE,
drop = TRUE,
collapse = NULL,
...
)
Arguments
tbl |
A data frame |
output |
Output column to be created as string or symbol. |
input |
Input column that gets split as string or symbol. The output/input arguments are passed by expression and support quasiquotation; you can unquote strings and symbols. |
token |
Unit for tokenizing, or a custom tokenizing function. Built-in options are "words" (default), "characters", "character_shingles", "ngrams", "skip_ngrams", "sentences", "lines", "paragraphs", "regex", and "ptb" (Penn Treebank). If a function, should take a character vector and return a list of character vectors of the same length. |
format |
Either "text", "man", "latex", "html", or "xml". When the format is "text", this function uses the tokenizers package. If not "text", this uses the hunspell tokenizer, and can tokenize only by "word". |
to_lower |
Whether to convert tokens to lowercase. |
drop |
Whether original input column should get dropped. Ignored if the original input and new output column have the same name. |
collapse |
A character vector of variables to collapse text across,
or For tokens like n-grams or sentences, text can be collapsed across rows
within variables specified by Grouping data specifies variables to collapse across in the same way as
|
... |
Extra arguments passed on to tokenizers, such
as |
Details
If format is anything other than "text", this uses the
hunspell::hunspell_parse()
tokenizer instead of the tokenizers package.
This does not yet have support for tokenizing by any unit other than words.
Support for token = "tweets"
was removed in tidytext 0.4.0 because of
changes in upstream dependencies.
Examples
library(dplyr)
library(janeaustenr)
d <- tibble(txt = prideprejudice)
d
d %>%
unnest_tokens(output = word, input = txt)
d %>%
unnest_tokens(output = sentence, input = txt, token = "sentences")
d %>%
unnest_tokens(output = ngram, input = txt, token = "ngrams", n = 2)
d %>%
unnest_tokens(chapter, txt, token = "regex", pattern = "Chapter [\\\\d]")
d %>%
unnest_tokens(shingle, txt, token = "character_shingles", n = 4)
# custom function
d %>%
unnest_tokens(word, txt, token = stringr::str_split, pattern = " ")
# tokenize HTML
h <- tibble(row = 1:2,
text = c("<h1>Text <b>is</b>", "<a href='example.com'>here</a>"))
h %>%
unnest_tokens(word, text, format = "html")