mc_metadata {multicastR}

Access the Multi-CAST metadata

Description

mc_metadata downloads a table with metadata on the texts and speakers in the Multi-CAST collection from the servers of the University of Bamberg.

Usage

mc_metadata(vkey = NULL)

Arguments

vkey

A four-digit number specifying the requested version of the metadata. 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 metadata is retrieved automatically.

Value

A data.frame containing metadata on 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] type

The text type, either TN 'traditional narrative', AN 'autobiographical narrative', or SN 'stimulus-based narrative'.

[, 4] recorded

The year (YYYY) the text was recorded.

[, 5] speaker

The identifier for the speaker.

[, 6] gender

The speaker's gender.

[, 7] age

The speaker's age at the time of recording. Approximate values are prefixed with a c.

[, 8] born

The speaker's birth year (YYY). Approximate values are prefixed with a c.

See Also

multicast, mc_index, mc_referents, mc_clauses

Examples

## Not run: 
  # retrieve the most recent version of the Multi-CAST metadata
  mc_metadata()

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

  # join the metadata to a table with annotation values
  mc <- multicast()
  merge(mc, mc_metadata(),
        by = c("corpus", "text"))

## End(Not run)