-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathREADME.Rmd
65 lines (43 loc) · 3.07 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
# Package Template for the cloudyr project
[](https://cran.r-project.org/package=aws.transcribe)
[](https://travis-ci.org/cloudyr/aws.transcribe)
[](https://ci.appveyor.com/project/cloudyr/aws.transcribe)
[](https://codecov.io/github/cloudyr/aws.transcribe?branch=master)
**aws.transcribe** is a package for the [AWS Transcribe](https://aws.amazon.com/transcribe/) API.
## Code Examples
To start a transcription, use `start_transcription()` with a "job name" and the URL for the file to be transcribed:
```R
library("aws.transcribe")
t1 <- start_transcription("aws-transcribe-example", "https://s3.amazonaws.com/randhunt-transcribe-demo-us-east-1/out.mp3")
```
Then, wait for the transcription to complete and retrieve it by name using `get_transcription()`:
```{r}
library("aws.transcribe")
t1 <- get_transcription("aws-transcribe-example")
cat(strwrap(t1$Transcriptions[1L], 60), sep = "\n")
```
That's it!
## Setting up credentials
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")
```
## Installation
You can install this package from CRAN or, to install the latest development version, from the cloudyr drat repository:
```R
# Install from CRAN
install.packages("aws.transcribe")
# Latest version passing CI tests, from drat repo
install.packages("aws.transcribe", repos = c(getOption("repos"), "http://cloudyr.github.io/drat"))
```
You can also pull a potentially unstable version directly from GitHub, using the `remotes` package:
```R
remotes::install_github("cloudyr/aws.transcribe")
```
---
[](https://github.com/cloudyr)