multicastR (version 1.3.0)

mc_referents: Access the Multi-CAST list of referents

Description

mc_referents downloads the lists of referents for all texts in the Multi-CAST collection that have been annotated with the RefIND scheme (Referent Indexing in Natural-language Discourse, Schiborr et al. 2018). The data are downloaded from the servers of University of Bamberg and presented as a data.table.

Usage

mc_referents(vkey)

Arguments

vkey

A numeric or character vector of length 1 specifying the requested version of the annotation values. Must be one of the four-digit version keys in the first column of mc_index, or empty. If empty or no value is supplied, the most recent version of the annotations is retrieved automatically. Note that the first annotations with RefIND were added with version 1905 (May 2019), and hence no lists of referents exist for earlier versions (i.e. 1505 and 1606).

Value

A data.table containing lists of referents for all texts with RefIND annotations in the Multi-CAST collection. The table has the following eight columns:

[, 1] corpus

The name of the corpus.

[, 2] text

The title of the text.

[, 3] refind

The four-digit referent index, unique to each referent in a text.

[, 4] label

The label used for the referent.

[, 5] description

A short description of the referent.

[, 6] class

The semantic class of the referent. Legend: hum = human, anm = animate, inm = inanimate, bdp = body part, mss = mass, loc = location, tme = time, abs = abstract.

[, 7] relations

Relations of the referent to other referents. Legend: < = set member of (partial co-reference), > = includes (split antecedence), M = part-whole.

[, 8] notes

Annotators' notes on the referent and its properties.

See Also

multicast, mc_index, mc_metadata, mc_clauses

Examples

# NOT RUN {
  # retrieve the most recent version of the Multi-CAST lists of referents
  mc_referents()

  # retrieve the lists of referents published in May 2019
  mc_referents(1905)   # or: mc_referents("1905")

  # join the list of referents to a table with annotation values
  mc <- multicast()
  merge(mc, mc_referents(),
        by = c("corpus", "text", "refind"),
        all.x = TRUE)
# }
# NOT RUN {
# }