tree ab4765d58244966760d3b28bbdb3f4dd1fe3e859
parent c3de7021d07e2952c65af3243310a6fb8ba27995
author Marc Kupietz <kupietz@ids-mannheim.de> 1788853129 +0200
committer Marc Kupietz <kupietz@ids-mannheim.de> 1788876164 +0200

Readme: say what a cacheAs file is good for besides speed

The passage introducing cacheAs framed it as a way around slow collocation
analyses, which is still its main use and now more so, since comparing
them across virtual corpora multiplies the waiting. But the parameter is
no longer collocationAnalysis' alone, and for the quick functions that
reason does not apply: a kept file holds the numbers a text was written
about, which KorAP answers differently once the corpus has grown, and it
lets a script run again with no server at all - which was checked against
a connection whose requests all fail.

That a file is not reused for a call it was not written for is worth
saying too, since the alternative would be silently wrong numbers. And
since it is not, keeping one under version control next to the document
is worth suggesting, with cacheAsInfo() to read back what it rests on,
blessCacheAs() to vouch for a file that is sound all the same, and
withCachedResults() for when there is no time to recompute anything.

Also documents that a named vc vector labels the rows of corpusStats(),
frequencyQuery() and collocationScoreQuery(), which so far only
collocationAnalysis() was said to do. The connection's cache now points
at cacheAs, the two being easy to confuse.

Change-Id: I03e1b9cada8ad76cf7aeacb68d285315c8ab1499
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>