man/cacheAsInfo.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/cacheAs.R
\name{cacheAsInfo}
\alias{cacheAsInfo}
\title{What produced a cacheAs file}
\usage{
cacheAsInfo(cacheAs)
}
\arguments{
\item{cacheAs}{path to the file, with or without its \code{.rds} extension}
}
\value{
a list with the elements \code{scoreVersion}, \code{packageVersion},
\code{parameters}, \code{dots},
\code{apiUrl} and \code{indexRevision}, or \code{NULL} for a file written by a version
before 1.4.0, which recorded none of this
}
\description{
Reads back what a query function recorded in a \link{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.
}
\examples{
\dontrun{
KorAPConnection() |> frequencyQuery("Ameisenplage", cacheAs = "ameisenplage.rds")
cacheAsInfo("ameisenplage.rds")
}

}
\seealso{
Other cacheAs:
\code{\link[=blessCacheAs]{blessCacheAs()}},
\code{\link[=withCachedResults]{withCachedResults()}}
}
\concept{cacheAs}