Type:	Package
Title:	Client for 'AWS Comprehend'
Version:	0.2.1
Date:	2020-03-10
Description:	Client for 'AWS Comprehend' https://aws.amazon.com/comprehend, a cloud natural language processing service that can perform a number of quantitative text analyses, including language detection, sentiment analysis, and feature extraction.
License:	GPL-2 | GPL-3 [expanded from: GPL (≥ 2)]
URL:	https://github.com/cloudyr/aws.comprehend
BugReports:	https://github.com/cloudyr/aws.comprehend/issues
Imports:	httr, jsonlite, aws.signature (≥ 0.3.4)
Suggests:	testthat (≥ 2.1.0)
Depends:	R (≥ 3.5.0)
Encoding:	UTF-8
RoxygenNote:	7.0.2
NeedsCompilation:	no
Packaged:	2020-03-18 13:30:25 UTC; asac
Author:	Thomas J. Leeper [aut], Antoine Sachet [aut, cre], Dave Kincaid [ctb]
Maintainer:	Antoine Sachet <antoine.sac@gmail.com>
Repository:	CRAN
Date/Publication:	2020-03-18 14:30:06 UTC

aws.comprehend

Description

AWS Comprehend Client Package

Details

Client for AWS Comprehend (https://aws.amazon.com/comprehend0, a cloud natural language processing service that can perform a number of quantitative text analyses, including language detection, sentiment analysis, and feature extraction.

Author(s)

Thomas J. Leeper <thosjleeper@gmail.com>

See Also

detect_language, detect_sentiment, detect_entities, detect_phrases

Bind and index a ResultList

Description

Turn a list of data.frames (of different lengths and potentially empty) into a single indexed data.frame. Useful to process a ResultList from 'comprehendHTTP'.

Usage

bind_and_index(index, df_list)

Arguments

Details

'index' and 'df_list' should be the same length. An error is raised otherwise.

bind_and_index(1:2, list(data.frame(col = "a"), data.frame(col = "b")))

bind_and_index(1:3, list( data.frame(col = "a"), data.frame(), data.frame(c("b", "c"))))

Execute AWS Comprehend API Request

Description

This is the workhorse function to execute calls to the Comprehend API.

Usage

comprehendHTTP(
  action,
  query = list(),
  headers = list(),
  body = NULL,
  verbose = getOption("verbose", FALSE),
  region = Sys.getenv("AWS_DEFAULT_REGION", "us-east-1"),
  key = NULL,
  secret = NULL,
  session_token = NULL,
  service = c("comprehend", "comprehendmedical"),
  ...
)

Arguments

Details

This function constructs and signs an Polly API request and returns the results thereof, or relevant debugging information in the case of error.

Value

If successful, a named list. Otherwise, a data structure of class “aws-error” containing any error message(s) from AWS and information about the request attempt.

Author(s)

Thomas J. Leeper

Detect named entities in a source text

Description

Detect entities in a source text

Usage

detect_entities(text, language = "en", ...)

Arguments

Value

A data frame

Examples

## Not run: 
  # simple example
  detect_entities("Amazon provides web services. Jeff is their leader.")
  
  txt <-c("Amazon provides web services, like Google.",
          "Jeff is their leader.")
  detect_entities(txt)

## End(Not run)

Detect language in a source text

Description

Detect language(s) in a source text

Usage

detect_language(text, ...)

Arguments

Value

A data frame of language probabilities.

Examples

## Not run: 
  # simple example
  detect_language("This is a test sentence in English")
  
  # two languages in a single text
  txt <- "A: ¡Hola! ¿Como está, usted?\nB: Ça va bien. Merci. Et toi?"
  detect_language(txt)

  # "batch" mode
  detect_language(c("A: ¡Hola! ¿Como está, usted?",
                    "B: Ça va bien. Merci. Et toi?"))

## End(Not run)

Detect named entities in a source medical text

Description

Detect entities in a source medical text

Usage

detect_medical_entities(text, language = "en", version = c("2", "1"), ...)

Arguments

Value

A data frame

Examples

## Not run: 
  # simple example
  medical_detect_entities("Mrs. Smith comes in today complaining of shortness of breath.")
  
  txt <-c("Mrs. Smith comes in today.",
          "She is complaining of shortnesss of breath.")
  medical_detect_entities(txt)

## End(Not run)

Detect Protected Health Information (PHI) in a source medical text

Description

Detect Protected Health Information (PHI) in a source medical text

Usage

detect_medical_phi(text, language = "en", ...)

Arguments

Value

A data frame

Examples

## Not run: 
  # simple example
  medical_detect_phi("Mrs. Smith comes in today complaining of shortness of breath.")
  
  txt <-c("Mrs. Smith comes in today.",
          "She is complaining of shortnesss of breath.")
  medical_detect_phi(txt)

## End(Not run)

Detect key phrases

Description

Detect key phrases in a source text

Usage

detect_phrases(text, language = "en", ...)

Arguments

Value

A data frame

Examples

## Not run: 
  # simple example
  detect_phrases("Amazon provides web services. Jeff is their leader.")
  
  txt <-c("Amazon provides web services.",
          "Jeff is their leader.")
  detect_phrases(txt)

## End(Not run)

Detect sentiment in a source text

Description

Detect sentiment in a source text

Usage

detect_sentiment(text, language = "en", ...)

Arguments

Value

A data frame

Examples

## Not run: 
  # simple example
  detect_sentiment("I have never been happier. This is the best day ever.")

  txt <-c("I have never been happier. This is the best day ever.",
          "I have always been happier. This is the worst day ever.")
  detect_sentiment(txt)

## End(Not run)

Detect syntax in a source text

Description

Detect syntax in a source text

Usage

detect_syntax(text, language = "en", ...)

Arguments

Value

A data frame

Examples

## Not run: 
  # simple example
  detect_syntax("The quick brown fox jumps over the lazy dog.")

  txt <-c("The quick brown fox jumps over the lazy dog.",
          "I have never been happier!")
  detect_syntax(txt)

## End(Not run)

Flatten embedded data.frames (1 level max)

Description

Flatten embedded data.frames (1 level max)

Usage

flatten(df)

Arguments