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

In 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). To retrieve the metadata for every text in a virtual corpus, use corpusQuery() with ⁠<base/s=t>⁠ as query, instead.

Usage

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

Arguments

kco	KorAPConnection() object (obtained e.g. from 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.
cacheAs	path to an RDS file to keep the result in. If the file exists and records the same call, it is read back instead of contacting the server; otherwise the query is run and its result stored there. Unlike the connection's cache, this file belongs to the caller, which is what keeps an analysis reproducible once the corpus has grown or the scores have changed. Defaults to NULL (no file).

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: 
KorAPConnection() |> textMetadata(c("WUD17/A97/08542", "WUD17/B96/57558", "WUD17/A97/08541"))

## End(Not run)

RKorAPClient documentation built on Sept. 9, 2026, 5:11 p.m.