quanteda.tidy (version 0.4)

pull.corpus: Pull out a single document variable

Description

Works like $ for quanteda objects with document variables, or like docvars(x, "varname").

Usage

# S3 method for corpus
pull(.data, var = -1, name = NULL, ...)
# S3 method for tokens
pull(.data, var = -1, name = NULL, ...)
# S3 method for dfm
pull(.data, var = -1, name = NULL, ...)

Value

A vector containing the values of the specified document variable.

Arguments

.data

a quanteda object with document variables

var

A variable specified as:

• a literal variable name

• a positive integer, giving the position counting from the left

• a negative integer, giving the position counting from the right.

The default returns the last column (on the assumption that's the column you've created most recently).

This argument is taken by expression and supports quasiquotation (you can unquote column names and column locations).

name

An optional parameter that specifies the column to be used as names for a named vector. Specified in a similar manner as var.

...

For use by methods.

Examples

tail(data_corpus_inaugural) %>% pull(President)
tail(data_corpus_inaugural) %>% pull(-1)
tail(data_corpus_inaugural) %>% pull(1)

toks <- data_corpus_inaugural %>%
  tail() %>%
  tokens()
pull(toks, President)

dfmat <- data_corpus_inaugural %>%
  tail() %>%
  tokens() %>%
  dfm()
pull(dfmat, President)