Gitiles
Code Review Sign In
korap.ids-mannheim.de / KorAP / RKorAPClient / ae1dc13faeeebc087408fa206f2cd30511d7e1ed
commitae1dc13faeeebc087408fa206f2cd30511d7e1ed[log] [tgz]
authorMarc Kupietz <kupietz@ids-mannheim.de>Fri Mar 05 15:08:13 2021 +0100
committerMarc Kupietz <kupietz@ids-mannheim.de>Fri Mar 05 15:17:26 2021 +0100
tree1321a9b248b434aa1c5c1a7a0621516feb019667
parentc66466c36f6982729ea63143cc3f69666ba4b3c5 [diff]
Add icon to Readme.md

Change-Id: I31bc055ee17a5358282959ef258b2a103815c870
1 file changed
tree: 1321a9b248b434aa1c5c1a7a0621516feb019667
  1. .github/
  2. demo/
  3. inst/
  4. man/
  5. R/
  6. tests/
  7. .gitignore
  8. .Rbuildignore
  9. cran-comments.md
  10. DESCRIPTION
  11. LICENSE
  12. LICENSE.md
  13. NAMESPACE
  14. NEWS.md
  15. Readme.md
  16. RKorAPClient.Rproj
Readme.md

KorAP web service client package for R

CRAN_Status_Badge CRAN downloads Project Status: Active – The project has reached a stable, usable state and is being actively developed. Lifecycle:stable Codecov test coverage Last commit GitHub closed issues GitHub issues check-windows check-mac check-linux Github Stars

Description

R client package to access the web service API of the KorAP Corpus Analysis Platform developed at IDS Mannheim

Installation

System Dependencies on Linux

RKorAPClient uses some R packages with system depencies you might need to install first:

#### Debian / Ubuntu
sudo apt install r-base-dev libcurl4-gnutls-dev libxml2-dev libsodium-dev

#### Fedora / CentOS >= 8 / RHEL >= 8
sudo dnf install R-devel libcurl-devel openssl-devel libxml2-devel libsodium-devel

#### CentOS < 8 / RHEL < 8
sudo yum install R-devel libcurl-devel openssl-devel libxml2-devel libsodium-devel

#### Arch Linux
pacman -S base-devel gcc-fortran libsodium curl

Package installation

CRAN version:

install.packages("RKorAPClient")

Development version (alternatives):

devtools::install_github("KorAP/RKorAPClient")
remotes::install_github("KorAP/RKorAPClient")
devtools::install_git("https://korap.ids-mannheim.de/gerrit/KorAP/RKorAPClient")
remotes::install_git("https://korap.ids-mannheim.de/gerrit/KorAP/RKorAPClient")

Examples

Hello world

library(RKorAPClient)
new("KorAPConnection", verbose=TRUE) %>% corpusQuery("Hello world") %>% fetchAll()

Frequencies over time and domains using ggplot2

library(RKorAPClient)
library(ggplot2)
kco <- new("KorAPConnection", verbose=TRUE)
expand_grid(condition = c("textDomain = /Wirtschaft.*/", "textDomain != /Wirtschaft.*/"), 
            year = (2002:2018)) %>%
    cbind(frequencyQuery(kco, "[tt/l=Heuschrecke]", paste0(.$condition," & pubDate in ", .$year)))  %>%
    ipm() %>%
    ggplot(aes(x = year, y = ipm, fill = condition, colour = condition)) +
    geom_freq_by_year_ci()

Percentages over time using highcharter

See the Highcharts license notes below.

library(RKorAPClient)
query = c("macht []{0,3} Sinn", "ergibt []{0,3} Sinn")
years = c(1980:2010)
as.alternatives = TRUE
vc = "textType = /Zeit.*/ & pubDate in"
new("KorAPConnection", verbose=T) %>%
  frequencyQuery(query, paste(vc, years), as.alternatives = as.alternatives) %>%
  hc_freq_by_year_ci(as.alternatives)

Proportion of "ergibt … Sinn" versus "macht … Sinn" between 1980 and 2010 in newspapers and magazines

Demos

More elaborate R scripts demonstrating the use of the package can be found in the demo folder.

Development and License

RKorAPClient

Authors: Marc Kupietz, Nils Diewald

Copyright (c) 2021, Leibniz Institute for the German Language, Mannheim, Germany

This package is developed as part of the KorAP Corpus Analysis Platform at the Leibniz Institute for German Language (IDS).

It is published under the BSD-2 License.

Further Affected Licenses and Terms of Services

Bundled Assets

The KorAP logo was designed by Norbert Cußler-Volz is released under the terms of the Creative Commons License BY-NC-ND 4.0.

Highcharts

RKorAPClient imports parts of the highcharter package which has a dependency on Highcharts, a commercial JavaScript charting library. Highcharts offers both a commercial license as well as a free non-commercial license. Please review the licensing options and terms before using the highcharter plot options, as the RKorAPClient license neither provides nor implies a license for Highcharts.

Highcharts is a Highsoft product which is not free for commercial and governmental use.

Accessed API Services

By using RKorAPClient you agree to the respective terms of use of the accessed KorAP API services which will be printed upon opening a connection (new("KorAPConnection", ...).

Contributions

Contributions are very welcome!

Your contributions should ideally be committed via our Gerrit server to facilitate reviewing (see Gerrit Code Review - A Quick Introduction if you are not familiar with Gerrit). However, we are also happy to accept comments and pull requests via GitHub.

Please note that unless you explicitly state otherwise any contribution intentionally submitted for inclusion into this software shall – as this software itself – be under the BSD-2 License.

References