context-class: Context class.

Description

Class to organize information of context analysis.

Usage

# S4 method for context
length(x)
# S4 method for context
p_attributes(.Object)
# S4 method for context
count(.Object)
# S4 method for context
sample(x, size)
# S4 method for context
enrich(
  .Object,
  s_attribute = NULL,
  p_attribute = NULL,
  decode = FALSE,
  verbose = TRUE,
  ...
)
# S4 method for context
as.regions(x, node = TRUE)
# S4 method for context
trim(
  object,
  s_attribute = NULL,
  positivelist = NULL,
  p_attribute = p_attributes(object),
  regex = FALSE,
  stoplist = NULL,
  verbose = TRUE,
  progress = TRUE,
  ...
)

Arguments

a context object

.Object

object

size

integer indicating sample size

s_attribute

s-attribute(s) to add to data.table in cpos-slot

p_attribute

p-attribute(s) to add to data.table in cpos-slot

decode

logical, whether to convert integer ids to expressive strings

verbose

logical, whether to be talkative

...

to maintain backwards compatibility if argument pAttribute is still used

node

A logical value, whether to include the node (i.e. query matches) in the region matrix generated when creating a partition from a context-object.

object

a context object

positivelist

tokens that are required to be present to keep a match

regex

logical, whether positivlist / stoplist is interpreted as regular expressions

stoplist

tokens that are used to exclude a match

progress

logical, whether to show progress bar

Slots

query: The query examined (character).

count

An integer value, the number of hits for the query.

partition

The partition the context object is based on.

size_partition

The size of the partition, a length-one integer vector.

left

A length-one integer value, the number of tokens to the left of the query match.

right

An integer value, the number of tokens to the right of the query match.

size

A length-one integer value, the number of tokens covered by the context-object, i.e. the number of tokens in the right and left context of the node as well as query matches.

size_match

A length-one integer value, the number of tokens matches by the query. Identical with the value in slot count if the query is not a CQP query.

size_coi

A length-one integer value, the number of tokens in the right and left context of the node (excluding query matches).

size_ref

A length-one integer value, the number of tokens in the partition, without tokens matched and the tokens in the left and right context.

boundary

An s-attribute (character).

p_attribute

The p-attribute of the query (character).

corpus

The CWB corpus used (character).

stat

A data.table, the statistics of the analysis.

encoding

Object of class character, encoding of the corpus.

cpos

A data.table, with the columns match_id, cpos, position, word_id.

method

A character-vector, statistical test used.

call

Object of class character, call that generated the object.

Details

Objects of the class context include a data.table in the slot cpos. The data.table will at least include the columns "match_id", "cpos" and "position".

The length-method will return the number of hits that were achieved.

The enrich-method can be used to add additional information to the data.table in the "cpos"-slot of a context-object.