mc_referents {multicastR}

Access the Multi-CAST list of referents

Description

mc_referents downloads a tabular list of all discourse referents occuring in those texts in the Multi-CAST collection that have been annotated with the RefIND scheme (Schiborr et al. 2018). The data are downloaded from the servers of University of Bamberg.

Usage

mc_referents(vkey = NULL)

Arguments

vkey

A four-digit number specifying the requested version of the list of referents. Must be one of the version keys listed in the first column of mc_index, or empty. If empty, the most recent version of the list of referents is retrieved automatically. Note that the first annotations with RefIND were added with version 1905 (May 2019) of Multi-CAST, and hence no lists of referents exist for earlier versions (i.e. 1505 and 1606).

Value

A data.frame containing a list 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 list of referents
  mc_referents()

  # retrieve the lists of referents published in January 2021
  mc_referents(2021)

  # 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)

## End(Not run)