all_words: Searches Text Column for Words

View source: R/all_words.R

all_wordsR Documentation

Searches Text Column for Words

Description

A convenience function to find words that begin with or contain a letter chunk and returns the frequency counts of the number of occurrences of each word.

Usage

all_words(
  text.var,
  begins.with = NULL,
  contains = NULL,
  alphabetical = TRUE,
  apostrophe.remove = FALSE,
  char.keep = char2space,
  char2space = "~~",
  ...
)

Arguments

text.var

The text variable.

begins.with

This argument takes a word chunk. Default is NULL. Use this if searching for a word beginning with the word chunk.

contains

This argument takes a word chunk. Default is NULL. Use this if searching for a word containing the word chunk.

alphabetical

logical. If TRUE orders rows alphabetically, if FALSE orders the rows by descending frequency.

apostrophe.remove

logical. If TRUE removes apostrophes from the text before examining.

char.keep

A character vector of symbol character (i.e., punctuation) that strip should keep. The default is to strip everything except apostrophes. This enables the use of special characters to be turned into spaces or for characters to be retained.

char2space

A vector of characters to be turned into spaces.

...

Other argument supplied to strip.

Value

Returns a dataframe with frequency counts of words that begin with or contain the provided word chunk.

Note

Cannot provide both begins.with and contains arguments at once. If both begins.with and contains are NULL. all_words returns a frequency count for all words.

See Also

term_match

Examples

## Not run: 
x1 <- all_words(raj$dialogue, begins.with="re")
head(x1, 10)
x2 <- all_words(raj$dialogue, "q")
head(x2, 10)
all_words(raj$dialogue, contains="conc")
x3 <- all_words(raj$dialogue)
head(x3, 10)
x4 <- all_words(raj$dialogue, contains="the")
head(x4)
x5 <- all_words(raj$dialogue, contains="read")
head(x5)

## Filter by nchar and stopwords
Filter(head(x3), min = 3)

## Keep spaces
all_words(space_fill(DATA$state, c("are you", "can be")))

## End(Not run)

qdap documentation built on May 31, 2023, 5:20 p.m.