R: textstat_simil/dist coercion methods

as.list.textstat_proxy {quanteda.textstats} | R Documentation

## textstat_simil/dist coercion methods

### Description

Coercion methods for objects created by `textstat_simil()` and `textstat_dist()`.

### Usage

    ## S3 method for class 'textstat_proxy'
    as.list(x, sorted = TRUE, n = NULL, diag = FALSE, ...)

    ## S3 method for class 'textstat_proxy'
    as.data.frame(
      x,
      row.names = NULL,
      optional = FALSE,
      diag = FALSE,
      upper = FALSE,
      ...
    )

### Arguments

`x` | any R object.
`sorted` | sort results in descending order if `TRUE`
`n` | the top `n` highest-ranking items will be returned. If n is `NULL`, return all items.
`diag` | logical; if `FALSE`, exclude the item's comparison with itself
`...` | additional arguments to be passed to or from methods.
`row.names` | `NULL` or a character vector giving the row names for the data frame. Missing values are not allowed.
`optional` | logical. If `TRUE`, setting row names and converting column names (to syntactic names: see `make.names`) is optional. Note that all of R's base package `as.data.frame()` methods use `optional` only for column names treatment, basically with the meaning of `data.frame(*, check.names = !optional)`. See also the `make.names` argument of the `matrix` method.
`upper` | logical; if `TRUE`, return pairs as both (A, B) and (B, A)

### Value

`as.data.list` for a `textstat_simil` or `textstat_dist` object returns a list equal in length to the columns of the simil or dist object, with the rows and their values as named elements. By default, this list excludes same-time pairs (when `diag = FALSE`) and sorts the values in descending order (when `sorted = TRUE`).

`as.data.frame` for a `textstat_simil` or `textstat_dist` object returns a data.frame of pairwise combinations and the and their similarity or distance value.

[Package quanteda.textstats version 0.94.1 Index]