# docvars

0th

Percentile

##### Get or set document-level variables

Get or set variables associated with a document in a corpus, tokens or dfm object.

Keywords
corpus
##### Usage
docvars(x, field = NULL)docvars(x, field = NULL) <- value
##### Arguments
x

corpus, tokens, or dfm object whose document-level variables will be read or set

field

string containing the document-level variable name

value

the new values of the document-level variable

##### Value

docvars returns a data.frame of the document-level variables, dropping the second dimension to form a vector if a single docvar is returned.

docvars<- assigns value to the named field

##### Note

Reassigning document variables for a tokens or dfm object is allowed, but discouraged. A better, more reproducible workflow is to create your docvars as desired in the corpus, and let these continue to be attached "downstream" after tokenization and forming a document-feature matrix. Recognizing that in some cases, you may need to modify or add document variables to downstream objects, the assignment operator is defined for tokens or dfm objects as well. Use with caution.

Another way to access and set docvars is through indexing of the corpus j element, such as data_corpus_irishbudget2010[, c("foren", "name"]; or, for a single docvar, data_corpus_irishbudget2010[["name"]]. The latter also permits assignment, including the easy creation of new document variables, e.g. data_corpus_irishbudget2010[["newvar"]] <- 1:ndoc(data_corpus_irishbudget2010). See [.corpus for details.

• docvars
• docvars<-
##### Examples
# NOT RUN {
# retrieving docvars from a corpus
tail(docvars(data_corpus_inaugural, "President"), 10)

# assigning document variables to a corpus
corp <- data_corpus_inaugural
docvars(corp, "President") <- paste("prez", 1:ndoc(corp), sep = "")