forked from cloudyr/aws.comprehend
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
67 lines (47 loc) · 3.05 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# AWS Comprehend Client Package
**aws.comprehend** is a package for natural language processing.
To use the package, you will need an AWS account and to enter your credentials into R. Your keypair can be generated on the [IAM Management Console](https://aws.amazon.com/) under the heading *Access Keys*. Note that you only have access to your secret key once. After it is generated, you need to save it in a secure location. New keypairs can be generated at any time if yours has been lost, stolen, or forgotten. The [**aws.iam** package](https://github.com/cloudyr/aws.iam) profiles tools for working with IAM, including creating roles, users, groups, and credentials programmatically; it is not needed to *use* IAM credentials.
A detailed description of how credentials can be specified is provided at: https://github.com/cloudyr/aws.signature/. The easiest way is to simply set environment variables on the command line prior to starting R or via an `Renviron.site` or `.Renviron` file, which are used to set environment variables in R during startup (see `? Startup`). They can be also set within R:
```R
Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey",
"AWS_SECRET_ACCESS_KEY" = "mysecretkey",
"AWS_DEFAULT_REGION" = "us-east-1",
"AWS_SESSION_TOKEN" = "mytoken")
```
## Code Examples
Here are some simple code examples:
```{r}
library("aws.comprehend")
# simple language detection
detect_language("This is a test sentence in English")
# multi-lingual language detection
detect_language("A: ¡Hola! ¿Como está, usted?\nB: Ça va bien. Merci. Et toi?")
# sentiment analysis
detect_sentiment("I have never been happier. This is the best day ever.")
# named entity recognition
txt <- c("Amazon provides web services.", "Jeff is their leader.")
detect_entities(txt)
# key phrase detection
detect_phrases(txt)
```
All of the functions accept either a single character string or a character vector.
## Installation
[](https://cran.r-project.org/package=aws.comprehend)
[](https://travis-ci.org/cloudyr/aws.comprehend)
[](https://ci.appveyor.com/project/cloudyr/aws.comprehend)
[](https://codecov.io/github/cloudyr/aws.comprehend?branch=master)
This package is not yet on CRAN. To install the latest development version you can install from the cloudyr drat repository:
```R
# latest stable version
install.packages("aws.comprehend", repos = c(cloudyr = "http://cloudyr.github.io/drat", getOption("repos")))
```
Or, to pull a potentially unstable version directly from GitHub:
```R
if (!require("remotes")) {
install.packages("remotes")
}
remotes::install_github("cloudyr/aws.comprehend")
```
---
[](https://github.com/cloudyr)