Learn R Programming

quanteda (version 1.1.1)

predict.textmodel_wordscores: Predict textmodel_wordscores

Description

Predict textmodel_wordscores

Usage

# S3 method for textmodel_wordscores
predict(object, newdata = NULL,
  se.fit = FALSE, interval = c("none", "confidence"), level = 0.95,
  rescaling = c("none", "lbg", "mv"), include_reftexts = TRUE, ...)

Arguments

object

a fitted Wordscores textmodel

newdata

dfm on which prediction should be made

se.fit

if TRUE, return standard errors as well

interval

type of confidence interval calculation

level

tolerance/confidence level for intervals

rescaling

"none" for "raw" scores; "lbg" for LBG (2003) rescaling; or "mv" for the rescaling proposed by Martin and Vanberg (2007). See References.

include_reftexts

if FALSE, reference texts are removed from the prediction

...

not used

Value

textmodel_wordscores() returns a list that is also classed as a textmodel_wordscores object, containing the following elements:

wordscores

the scores computed for each word in the training set (\(S_{wd}\) from Laver, Benoit and Garry 2003)

scale

either linear or logit, according to the value of scale

x

the dfm on which the wordscores model was called

y

the vector of document reference values

call

the function call that fitted the model

predict.textmodel_wordscores() returns a named vector of predicted document scores ("text scores" S_{vd} in LBG 2003), or a named list if se.fit = TRUE consisting of the predicted scores ($fit) and the associated standard errors ($se.fit). When interval = "confidence", the predicted values will be a matrix. This behaviour matches that of predict.lm.