πŸ’ R package for text analysis with Monkeylearn πŸ’
Clone or download

README.md

monkeylearn

CRAN_Status_Badge Build Status AppVeyor Build Status codecov

This R package is an interface to the MonkeyLearn API. MonkeyLearn is a Machine Learning platform on the cloud that allows software companies and developers to easily extract actionable data from text. πŸ’

The current goal of the package is not to support machine learning algorithms development with R or the API, but only to reap the benefits of the existing modules on Monkeylearn. Therefore, there are only two types of functions, one for using extractors (monkey_extract and the old less user-friendly monkeylearn_extract), and one for using classifiers (monkey_classify and the old less user-friendly monkeylearn_classify). The difference between extractors and classifiers is that extractors output information about words, whereas classifiers output information about each text as a whole. Named entity recognition is an extraction task, whereas assigning a topic to a text is a classification task.

Installation and setup

To install the stable CRAN version:

install.packages("monkeylearn")

To install the development version:

devtools::install_github("ropensci/monkeylearn")

To get an API key for MonkeyLearn, register at http://monkeylearn.com/. Note that MonkeyLearn supports registration through GitHub, which makes the registration process really easy. For ease of use, save your API key as an environment variable as described at http://stat545.com/bit003_api-key-env-var.html.

All functions of the package will conveniently look for your API key using Sys.getenv("MONKEYLEARN_KEY") so if your API key is an environment variable called "MONKEYLEARN_KEY" you don't need to input it manually.

Please also create a "MONKEYLEARN_PLAN" environment variable indicating whether your Monkeylearn plan is "free", "team" or "business".

Documentation

Please refer to the pkgdown website to read docs, in particular the reference and the vignettes.

External use cases

Submit your use cases by opening a new issue!

Using the newer set of functions monkey_extract and monkey_classify

Using the older set of functions monkeylearn_extract and monkeylearn_classify

Meta

  • Please report any issues or bugs.
  • License: GPL
  • Get citation information for monkeylearn in R doing citation(package = 'monkeylearn')
  • Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

ropensci_footer