multicast: Access Multi-CAST annotation data

Description Usage Arguments Value Licensing Citing Multi-CAST References See Also Examples

View source: R/multicast.R

Description

multicast downloads corpus data from the Multi-CAST collection (Haig & Schnell 2015) from the servers of the University of Bamberg. As the Multi-CAST collection is continuously evolving through the addition of further data sets and the revision of older annotations, the multicast function takes an optional argument vkey to select earlier versions of the annotation data, ensuring scientific accountability and the reproducibility of results.

Usage

1
multicast(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 with eleven columns:

[, 1] corpus

The name of the corpus.

[, 2] text

The name of the text.

[, 3] uid

The utterance identifier. Uniquely identifies an utterance within a text.

[, 4] gword

Grammatical words. The tokenized utterances in the object language.

[, 5] gloss

Morphological glosses following the Leipzig Glossing Rules.

[, 6] graid

Annotations with the GRAID scheme (Haig & Schnell 2014).

[, 7] gform

The form symbol of a GRAID gloss.

[, 8] ganim

The person-animacy symbol of a GRAID gloss.

[, 9] gfunc

The function symbol of a GRAID gloss.

[, 10] refind

Referent tracking using the RefIND scheme (Schiborr et al. 2018).

[, 11] isnref

Annotations of the information status of newly introduced referents.

Licensing

The Multi-CAST annotation data accessed by this package are published under a Create Commons Attribution 4.0 International (CC-BY 4.0) licence (https://creativecommons.org/licenses/by-sa/4.0/). Please refer to the Multi-CAST website for information on how to give proper credit to its contributors.

Citing Multi-CAST

Data from the Multi-CAST collection should be cited as:

If for some reason you need to cite this package specifically, please refer to citation(multicastR).

References

See Also

mc_index, mc_metadata, mc_referents, mc_clauses

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
  # retrieve and print the most recent version of the
  # Multi-CAST annotations
  multicast()

  # retrieve the version of the annotation data published
  # in January 2021
  multicast(2021)

## End(Not run)

multicastR documentation built on Feb. 23, 2021, 1:06 a.m.