A set of tools to analyze texts. Includes, amongst others, functions for automatic language detection, hyphenation, several indices of lexical diversity (e.g., type token ratio, HD-D/vocd-D, MTLD) and readability (e.g., Flesch, SMOG, LIX, Dale-Chall). Basic import functions for language corpora are also provided, to enable frequency analyses (supports Celex and Leipzig Corpora Collection file formats) and measures like tf-idf. Note: For full functionality a local installation of TreeTagger is recommended. It is also recommended to not load this package directly, but by loading one of the available language support packages from the 'l10n' repository < https://undocumeantit.github.io/repos/l10n/>. 'koRpus' also includes a plugin for the R GUI and IDE RKWard, providing graphical dialogs for its basic features. The respective R package 'rkward' cannot be installed directly from a repository, as it is a part of RKWard. To make full use of this feature, please install RKWard from < https://rkward.kde.org> (plugins are detected automatically). Due to some restrictions on CRAN, the full package sources are only available from the project homepage. To ask for help, report bugs, request features, or discuss the development of the package, please subscribe to the koRpus-dev mailing list (< https://korpusml.reaktanz.de>).
koRpus is an R package for text analysis. This includes, amongst others, a wrapper for the POS tagger TreeTagger, functions for automatic language detection, hyphenation, several indices of lexical diversity (e.g., type token ratio, HD-D/vocd-D, MTLD) and readability (e.g., Flesch, SMOG, LIX, Dale-Chall, Tuldava).
koRpus also includes a plugin for RKWard, a powerful GUI and IDE for R, providing graphical dialogs for its basic features. To make full use of this feature, please install RKWard (plugins are detected automatically).
More information on koRpus is available on the project homepage.
There are three easy ways of getting koRpus:
The latest release that is considered stable for productive work can be found on the CRAN mirrors, which means you can install it from a running R session like this:
The CRAN packages are usually a bit behind the recent state of the package, and only updated after a significant amount of changes or important bug fixes.
Inbetween stable CRAN releases there's usually several testing or development versions released on the project's own repository. These releases should also work without problems, but they are also intended to test new features or supposed bug fixes, and get feedback before the next release goes to CRAN.
Installation is fairly easy, too:
install.packages("koRpus", repo=c(getOption("repos"), reaktanz="https://reaktanz.de/R"))
To automatically get updates, consider adding the repository to your R configuration. You might also want to subscribe to the package's RSS feed to get notified of new releases.
If you're running a Debian based operating system, you might be interested in the precompiled *.deb packages.
To install it directly from GitHub, you can use
install_github() from the devtools package:
library(devtools) install_github("unDocUMeantIt/koRpus") # stable release install_github("unDocUMeantIt/koRpus", ref="develop") # development release
koRpus does not support any particular language out-of-the-box. Therefore, after installing the package you'll have
to also install at least one language support package to really make use of it.
You can find these in the l10n repository, they're called
The most straight forward way to get these packages is to use the function
Here's an example how to install support for English and German:
library(koRpus) install.koRpus.lang(lang=c("en", "de"))
There's also precompiled Debian packages.
To ask for help, report bugs, suggest feature improvements, or discuss the global development of the package, please either subscribe to the koRpus-dev mailing list, or use the issue tracker on GitHub.
Please note that all development happens in the
develop branch. Pull requests against the
branch will be rejected, as it is reserved for the current stable release.
Copyright 2012-2017 Meik Michalke [email protected]
koRpus is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
koRpus is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with koRpus. If not, see http://www.gnu.org/licenses/.