NEWS

RKorAPClient 0.8.1 (2024-05-02)

fixed R 4.4 compatibility of collocationAnalysis function
replaced deprecated legend.position (ggplot2)
fixed rare frequencyQuery incompatibility with outdated KorAP instances (see https://github.com/KorAP/Kustvakt/issues/668)

RKorAPClient 0.8.0 (2024-01-24)

added textMetadata KorAPConnection method to retrieve all metadata for a text based on its sigle
added webUiRequestUrl column also to corpusStats results, so that also virtual corpus definitions can be linked to / tested directly in the KorAP UI
added on-click action to open KorAP query also to highcharter scatter plots
if not metadataOnly is set, also tokenized snippets are now retrieved in corpus queries (stored in collectedMatches$tokens)
uses server side tokenized matches in collocation analysis, if supported by KorAP server
fixed regional demo (will be updated again soon)

RKorAPClient 0.7.7 (2023-08-08)

fixed R 4.3 compatibility (see https://github.com/KorAP/RKorAPClient/issues/12)
added demo that plots plural gender variant frequencies over time
added runtime OAuth2 browser flow demos with httr and httr2

RKorAPClient 0.7.6 (2023-04-19)

fixed error in recursiveCA demo
added documentation on authorization using the OAuth browser flow
fixed graceful fail on invalid json responses from API requests (CRAN policy violation)
updated Roxygen to 7.2.3
added context parameter to corpusQuery
updated GitHub workflows
in collocationAnalysis: given withinSpan parameters are now correctly passed to queries for examples
replaced our log.info function with log_info to avoid name clashes

RKorAPClient 0.7.5 (2022-09-07)

resolved CRAN policy violation (writing to user's home filespace)

RKorAPClient 0.7.4

resolved CRAN requests:
- documentation completed and improved for hc_add_onclick_korap_search, hc_freq_by_year_ci, KorAPConnection class
- proper cache directory used in regional demo
- fixed and improved path handling in collocation analysis and light verb construction demos
- fixed documentation for reexported magrittr::%>% (pipe function)
replaced head with dplyr::slice_head when used on data frames or tibbles

RKorAPClient 0.7.3

updated Roxygen to 7.2.1 (fixes bug that caused CRAN removal of RKorAPClient)
updated shiny demo
added some demos for comparisons by country of publication
fixed collocation scores for lemmatized node or collocate queries

RKorAPClient 0.7.2 (2022-03-01)

now fails gracefully with an informative message if the API server is not accessible
fixed shiny demo
hc_add_onclick_korap_search() now also works with bar, column and pie highcharts
new parameters added to collocationAnalysis function:
- maxRecurse - apply collocation analysis recursively maxRecurse times
- addExamples - If TRUE, examples for instances of collocations will be added in a column example. This makes a difference in particular if 'node' is given as a lemma query.
- thresholdScore - association score function to use for computing the threshold that is applied for recursive collocation analysis calls
- threshold- minimum value of thresholdScore function call to apply collocation analysis recursively

RKorAPClient 0.7.1 (2021-09-21)

documentation migrated to roxygen2md
Some examples in the documentation are now wrapped with:
```
   ## Not run
   ...
   ## End(Not run)
```
This was necessary to meet the time limits of automatic CRAN checks under all circumstances and has otherwise no significance,

Version change invalidates cache

The change of the minor version from 6 to 7 automatically invalidates your cached query results. However, since the API has not changed, you can continue using the old cached results by copying or renaming your cache folder.

On linux, for example, this can look like this:

mv ~/.cache/R/R.cache/RKorAPClient_0.6 ~/.cache/R/R.cache/RKorAPClient_0.7

or like this:

mv ~/.Rcache/RKorAPClient_0.6 ~/.Rcache/RKorAPClient_0.7

To find the RKorAPClient cache directory for your environment, you can use:

R.cache::getCacheRootPath()

RKorAPClient 0.7.0

New Features

experimental new collocationAnalysis method (client-sided)
new parameter randomizePageOrder to fetch result pages in randomized order
new parameter ignoreCollocateCase in collocationScoreQuery
new parameter withinSpan (default: base/s=s) in collocationScoreQuery
number of hits logged during queries, if verbose=TRUE

Bug Fixes

fixed umlaut queries on windows
fixed retrieval of access token when multiple access tokens are stored

RKorAPClient 0.6.1 (2021-03-12)

Changes

fixes calculation of logDice coefficient
updated Readme.md

RKorAPClient 0.6.0

Changes

collocationScoreQuery method added
hc_add_onclick_korap_search function added
shiny web application demo added
support for orphaned plotly package dropped
improved documentation structure

RKorAPClient 0.5.9 (2020-06-07)

Changes

The local cache is now notified of new corpus index revisions when new connections are established. As a side effect, with v0.5.9 existing caches are invalidated.

RKorAPClient 0.5.8

Changes

New boolean parameter smooth added to hc_freq_by_year_ci

Bug Fixes

Fixed issues with dplyr 1.0

RKorAPClient 0.5.7 (2020-03-17)

Changes

Introduced continuous integration tests via gh-actions, pulled from highcharter (thanks @pachamaltese)

Bug Fixes

Fixed some links in Readme.md
Removed redundant curl import
Fixed handling of single query term queries in highcharter-helper that had an empty plot and a warning
```
Unknown or uninitialised column: 'condition'.
```
as consequences.

RKorAPClient 0.5.6 (2020-03-13)

Fix some links in Readme.md
First release on CRAN

RKorAPClient 0.5.5

Use TRUE and FALSE instead of T and F
Be more specific about authors and rights holder
Elaborate Description field in DESCRIPTION file
Add forthcoming LREC paper to Readme.md

RKorAPClient 0.5.4

Fix DESCRIPTION file.

RKorAPClient 0.5.3

Further minimization of tests to make CRAN happy.
Make authors and maintainers machine readable.

RKorAPClient 0.5.2

Further minimization of tests to make CRAN happy. Safety shouldn't suffer.
Make license specification github and CRAN compliant.

RKorAPClient 0.5.1

Fixed many typos.
Removed redundant and too long running tests.

RKorAPClient 0.5.0

Initial release on CRAN.
Merge highcharter branch providing the new helper function hc_freq_by_year_ci.
Fix reporting cached results in verbose mode.
Add demo for comparing frequencies in spoken vs. written virtual corpora. See demo("writtenVsSpoken")
Don't invalidate cache on patch level increments.