textMetadata-KorAPConnection-method: Retrieve metadata for a text, identified by its sigle (id)

In KorAP/RKorAPClient: 'KorAP' Web Service Client Package

Retrieve metadata for a text, identified by its sigle (id)

Description

Retrieves metadata for a text, identified by its sigle (id) using the corresponding KorAP API (see Kustvakt Wiki).

Usage

## S4 method for signature 'KorAPConnection'
textMetadata(kco, textSigle, verbose = kco@verbose)

Arguments

kco	KorAPConnection() object (obtained e.g. from new("KorAPConnection"))
textSigle	unique text id (concatenation of corpus, document and text ids, separated by /, e.g. ) or vector thereof
verbose	logical. If TRUE, additional diagnostics are printed. Defaults to kco@verbose.

Value

Tibble with columns for each metadata property. In case of errors, such as non-existing texts/sigles, the tibble will also contain a column called errors. If there are metadata columns you cannot make sense of, please ignore them. The function simply returns all the metadata it gets from the server.

Examples

## Not run: 
new("KorAPConnection") %>% textMetadata(c("WUD17/A97/08542", "WUD17/B96/57558", "WUD17/A97/08541"))

## End(Not run)

KorAP/RKorAPClient documentation built on Feb. 6, 2024, 2:28 p.m.