Gitiles
Code Review Sign In
korap.ids-mannheim.de / KorAP / RKorAPClient / d669022d4870df3072210c616d6f67f491819181
commitd669022d4870df3072210c616d6f67f491819181[log] [tgz]
authorMarc Kupietz <kupietz@ids-mannheim.de>Wed Mar 04 21:02:29 2020 +0100
committerMarc Kupietz <kupietz@ids-mannheim.de>Wed Mar 04 21:02:29 2020 +0100
tree60152a17c676ebca7e0eceeae6ba07e2690857f6
parent450f5368b8cdd7cfd6fc9db6ebf7b4fc1f5886c0 [diff]
Fix some typos in Readme.md

Change-Id: Ife0ac6a88a06843693399596ff0510428b52a500
1 file changed
tree: 60152a17c676ebca7e0eceeae6ba07e2690857f6
  1. demo/
  2. man/
  3. R/
  4. .gitignore
  5. .Rbuildignore
  6. cran-comments.md
  7. DESCRIPTION
  8. LICENSE
  9. LICENSE.md
  10. NAMESPACE
  11. NEWS.md
  12. Readme.md
  13. RKorAPClient.Rproj
Readme.md

KorAP web service client package for R

Description

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

This package is in its early stages and not stable yet! In particular, please expect that, at this early stage, objects, functions, parameters as well as their names or identifiers will still change continuously without any notification. Use it on your own risk!

Getting started

At this point there is no binary package on CRAN yet, so you have to install the development version from our Gerrit server using the devtools package:

# install.packages("devtools")
library(devtools)
install_git("https://korap.ids-mannheim.de/gerrit/KorAP/RKorAPClient") 
library(RKorAPClient)
?corpusQuery
?frequencyQuery

Hello world

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

Examples

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

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

Authors: Marc Kupietz, Nils Diewald

Copyright (c) 2020, 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.

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