quanteda (version 1.1.1)

dfm-class: Virtual class "dfm" for a document-feature matrix

Description

The dfm class of object is a type of Matrix-class object with additional slots, described below. quanteda uses two subclasses of the dfm class, depending on whether the object can be represented by a sparse matrix, in which case it is a dfm class object, or if dense, then a dfmDense object. See Details.

Usage

# S4 method for dfm
t(x)
# S4 method for dfm
colSums(x, na.rm = FALSE, dims = 1L, ...)
# S4 method for dfm
rowSums(x, na.rm = FALSE, dims = 1L, ...)
# S4 method for dfm
colMeans(x, na.rm = FALSE, dims = 1L, ...)
# S4 method for dfm
rowMeans(x, na.rm = FALSE, dims = 1L, ...)
# S4 method for dfm,numeric
+(e1, e2)
# S4 method for numeric,dfm
+(e1, e2)
# S4 method for dfm,index,index,missing
[(x, i, j, ..., drop = FALSE)
# S4 method for dfm,index,index,logical
[(x, i, j, ..., drop = FALSE)
# S4 method for dfm,missing,missing,missing
[(x, i, j, ..., drop = FALSE)
# S4 method for dfm,missing,missing,logical
[(x, i, j, ..., drop = FALSE)
# S4 method for dfm,index,missing,missing
[(x, i, j, ..., drop = FALSE)
# S4 method for dfm,index,missing,logical
[(x, i, j, ..., drop = FALSE)
# S4 method for dfm,missing,index,missing
[(x, i, j, ..., drop = FALSE)
# S4 method for dfm,missing,index,logical
[(x, i, j, ..., drop = FALSE)

Arguments

x

the dfm object

na.rm

if TRUE, omit missing values (including NaN) from the calculations

dims

ignored

...

additional arguments not used here

e1

first quantity in "+" operation for dfm

e2

second quantity in "+" operation for dfm

i

index for documents

j

index for features

drop

always set to FALSE

Slots

settings

settings that govern corpus handling and subsequent downstream operations, including the settings used to clean and tokenize the texts, and to create the dfm. See settings.

weighting

the feature weighting applied to the dfm. Default is "frequency", indicating that the values in the cells of the dfm are simple feature counts. To change this, use the dfm_weight method.

smooth

a smoothing parameter, defaults to zero. Can be changed using either the smooth or the dfm_weight methods.

Dimnames

These are inherited from Matrix-class but are named docs and features respectively.

Details

The dfm class is a virtual class that will contain dgCMatrix-class.

See Also

dfm

Examples

# NOT RUN {
# dfm subsetting
x <- dfm(tokens(c("this contains lots of stopwords",
                  "no if, and, or but about it: lots",
                  "and a third document is it"),
                remove_punct = TRUE))
x[1:2, ]
x[1:2, 1:5]

# fcm subsetting
y <- fcm(tokens(c("this contains lots of stopwords",
                  "no if, and, or but about it: lots"),
                remove_punct = TRUE))
y[1:3, ]
y[4:5, 1:5]
# }