'KorAP' Web Service Client Package
Overview
A client package that makes the 'KorAP' web service API accessible from R. The corpus analysis platform 'KorAP' has been developed as a scientific tool to make potentially large, stratified and multiply annotated corpora, such as the 'German Reference Corpus DeReKo' or the 'Corpus of the Contemporary Romanian Language CoRoLa', accessible for linguists to let them verify hypotheses and to find interesting patterns in real language use. The 'RKorAPClient' package provides access to 'KorAP' and the corpora behind it for user-created R code, as a programmatic alternative to the 'KorAP' web user-interface. You can learn more about 'KorAP' and use it directly on 'DeReKo' at https://korap.ids-mannheim.de/.
- **follows the DeReKo-KorAP-2026-II release** of the German Reference Corpus, the default corpus of the default KorAP instance, which replaced the
textClassmetadata field bydmozDomainandwikiDomain.corpusQuery()now fetches both by default, so that the topic domain of matches is available again (#31). - **long running searches are no longer aborted after 10 minutes**. The underlying curl library gave up on transfers delivering less than one byte per second for 600 seconds, which is just what a search does while the server is still counting, regardless of the
timeoutof the connection. Only that timeout applies now - **failed and incomplete searches are reported**:
corpusQuery()andfrequencyQuery()now warn when a request failed or when the KorAP server cut a search short (timeExceeded), instead of silently reporting 0 or too few hits. Their data frame results carry the newqueryDurationcolumn, the time in seconds a request took on the client side - **clearer verbose output**: a series of queries or virtual corpora is logged as an aligned table, one row per item with its hits or tokens, the time it took and whether it came from the cache, followed by a one-line summary. A virtual corpus definition shared by all rows is named once in the header, e.g.
textType = /Zeit.*/ & pubDate in …, and the rows show only what varies. The estimated remaining time no longer counts the query just finished as pending, which made it about twice too long in the beginning, and ignores cached queries. Numbers beyond 2^31, e.g. the token count of the whole of DeReKo, are no longer printed asNA, and no colour codes are written where the output does not go to a terminal or the RStudio console, e.g. to a log file
From NEWS.md in the release
Install
Health
- OK13 OK2026-09-05
- NOTE11 OK, 2 NOTE2026-08-25
- ERROR10 OK, 2 NOTE, 1 ERROR2026-08-20
- NOTE12 OK, 1 NOTE2026-07-11
- OK13 OK2026-06-09
Show 4 earlier changesHide 4 earlier changes
- ERROR12 OK, 1 ERROR2026-06-08
- OK13 OK2026-06-07
- ERROR12 OK, 1 ERROR2026-05-30
- OK14 OK2026-03-10
Documentation
- Help pages
- 40 (15 internal)includes a package overview page
- Examples that run
- 5%1 run in a plain check · 21 never run
- Exported functions with examples
- 58%
- Documented parameters
- 85%
- Return-value docs
- 83%
- Help pages citing references
- 10%
Also includes 20 demo scripts (run with demo())
Downloads
Repository
- PRs merged (all time)
- 100%
- Median days to close, 50 most recently updated closed issues
- 3
- Median days to close, 50 most recently updated closed PRs
- 0
Stars over time
Forks over time
Releases over time
Issues over time
Commits over time
7 development-tooling and community-health practices detected across 5 families in the upstream repository
Checks run against github.com/korap/rkorapclient on 2026-10-18.
The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel
GitHub Pages site last deployed 2021-11-21
Show all practicesHide 1 practice
This repository shows signs of AI coding tools.
- Claude Codefirst seen 2025-06-19Named in .Rbuildignore: .claude, CLAUDE.mdNamed in .gitignore: .claudeCommits: at least 59 crediting it in the message
- Codexfirst seen 2026-05-01Named in .Rbuildignore: .codexNamed in .gitignore: .codex
- Gemini CLIfirst seen on or before 2026-07-18Config: a file or ignore line, not recorded which
- Claude Opus 550 commits · Aug to Sep 2026
- Claude Opus 5.58 commits · Sep to Oct 2026
- Claude Sonnet 51 commit · Jul 2026
Dependencies
Installing RKorAPClient adds 81 packages (47 with compiled code, 66 MB of source tarballs). Heaviest: stringi 11 MB, ggplot2 6.0 MB, data.table 5.7 MB.
Code & Tests
People & History
Pick two releases to compare their code metrics.
- 1.4.1Latest
- 1.4.0
- 1.3.02026-08-31 · diff ↗
- RR 4.6.0 released · 2026-04-24
- 1.2.12025-10-09 · diff ↗
- 1.2.02025-09-10 · diff ↗
- 1.1.02025-06-26 · diff ↗
- RR 4.5.0 released · 2025-04-11
- 1.0.02025-02-20 · diff ↗
- 0.9.0
- 0.8.12024-05-02 · diff ↗
- RR 4.4.0 released · 2024-04-24
- 0.8.02024-01-24 · diff ↗
- 0.7.72023-08-08 · diff ↗
- RR 4.3.0 released · 2023-04-21
- 0.7.62023-04-19 · diff ↗
Show 13 earlier eventsHide 13 earlier events
- unarchivedReturned to CRAN2022-09-07
- 0.7.5
- archivedRemoved from CRAN2022-08-12email to the maintainer is undeliverable
- RR 4.2.0 released · 2022-04-22
- 0.7.22022-03-01 · diff ↗
- 0.7.1
- RR 4.1.0 released · 2021-05-18
- 0.6.12021-03-12 · diff ↗ ·
removed 1 export
ggplotlyadded 7 exports
defaultAssociationScoreFunctions, hc_add_onclick_korap_search, ll, logDice, mi2, mi3, pmi - 0.5.9
- RR 4.0.0 released · 2020-04-24
- 0.5.72020-03-17 · diff ↗
- 0.5.62020-03-13
- RR 3.6.0 released · 2019-04-26
Package metadata
- First published
- 2020-03-13
- Total releases
- 19 / 6 yrs
- License
- BSD_2_clause + file LICENSE OSI
- Minimum R
- ≥ 4.1.0
- Download size
- 410 KB
Cite
Cite this package
Run in R for the authors' entry:
citation("RKorAPClient")The package provides a citation file, so citation() returns the authors' own entry.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-21, which the citation names so these numbers can be found later. More on citing and the projects behind them.