cacheAsInfo: What produced a cacheAs file

View source: R/cacheAs.R

cacheAsInfoR Documentation

What produced a cacheAs file

Description

Reads back what a query function recorded in a cacheAs file: the parameters it was called with, the KorAP instance it asked, the index revision that instance's corpus had at the time, and the version of RKorAPClient that wrote the file. Useful for saying, of a result kept next to a document, what the numbers in it rest on.

Usage

cacheAsInfo(cacheAs)

Arguments

cacheAs

path to the file, with or without its .rds extension

Value

a list with the elements scoreVersion, packageVersion, parameters, dots, apiUrl and indexRevision, or NULL for a file written by a version before 1.4.0, which recorded none of this

See Also

Other cacheAs: blessCacheAs(), withCachedResults()

Examples

## Not run: 
KorAPConnection() |> frequencyQuery("Ameisenplage", cacheAs = "ameisenplage.rds")
cacheAsInfo("ameisenplage.rds")

## End(Not run)


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