From 3c03a87bae003d6bb63afe54391293771bc2b2f0 Mon Sep 17 00:00:00 2001 From: Simon Spavound Date: Sat, 13 Mar 2021 15:02:02 +0000 Subject: [PATCH 1/5] modify README --- .Rbuildignore | 28 ++++----- README.Rmd | 130 +++++++++++++++++++++--------------------- README.md | 154 +++++++++++++++++++++++++------------------------- 3 files changed, 156 insertions(+), 156 deletions(-) diff --git a/.Rbuildignore b/.Rbuildignore index a207d3c..8e4f666 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -1,14 +1,14 @@ -.travis.yml -appveyor.yml -CONTRIBUTING.md -README.Rmd -Makefile -drat.sh -knitreadme.sh -^revdep$ -^man-roxygen$ -^.*\.Rproj$ -^\.Rproj\.user$ -^\.github.? -^cran-comments\.md$ -^CRAN-RELEASE$ +.travis.yml +appveyor.yml +CONTRIBUTING.md +README.Rmd +Makefile +drat.sh +knitreadme.sh +^revdep$ +^man-roxygen$ +^.*\.Rproj$ +^\.Rproj\.user$ +^\.github.? +^cran-comments\.md$ +^CRAN-RELEASE$ \ No newline at end of file diff --git a/README.Rmd b/README.Rmd index 54c42a9..ce17aa5 100644 --- a/README.Rmd +++ b/README.Rmd @@ -1,65 +1,65 @@ -# Package Template for the cloudyr project - -[![CRAN](https://www.r-pkg.org/badges/version/aws.transcribe)](https://cran.r-project.org/package=aws.transcribe) -![Downloads](https://cranlogs.r-pkg.org/badges/aws.transcribe) -[![Travis Build Status](https://travis-ci.org/cloudyr/aws.transcribe.png?branch=master)](https://travis-ci.org/cloudyr/aws.transcribe) -[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/PROJECTNUMBER?svg=true)](https://ci.appveyor.com/project/cloudyr/aws.transcribe) -[![codecov.io](https://codecov.io/github/cloudyr/aws.transcribe/coverage.svg?branch=master)](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") -``` - - - ---- -[![cloudyr project logo](https://i.imgur.com/JHS98Y7.png)](https://github.com/cloudyr) +# R Client for the AWS Transcribe API + +[![CRAN](https://www.r-pkg.org/badges/version/aws.transcribe)](https://cran.r-project.org/package=aws.transcribe) +![Downloads](https://cranlogs.r-pkg.org/badges/aws.transcribe) +[![Travis Build Status](https://travis-ci.org/cloudyr/aws.transcribe.png?branch=master)](https://travis-ci.org/cloudyr/aws.transcribe) +[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/PROJECTNUMBER?svg=true)](https://ci.appveyor.com/project/cloudyr/aws.transcribe) +[![codecov.io](https://codecov.io/github/cloudyr/aws.transcribe/coverage.svg?branch=master)](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") +``` + + + +--- +[![cloudyr project logo](https://i.imgur.com/JHS98Y7.png)](https://github.com/cloudyr) diff --git a/README.md b/README.md index 164a769..c02a8e2 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,77 @@ -# Package Template for the cloudyr project - -[![CRAN](https://www.r-pkg.org/badges/version/aws.transcribe)](https://cran.r-project.org/package=aws.transcribe) -![Downloads](https://cranlogs.r-pkg.org/badges/aws.transcribe) -[![Travis Build Status](https://travis-ci.org/cloudyr/aws.transcribe.png?branch=master)](https://travis-ci.org/cloudyr/aws.transcribe) -[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/PROJECTNUMBER?svg=true)](https://ci.appveyor.com/project/cloudyr/aws.transcribe) -[![codecov.io](https://codecov.io/github/cloudyr/aws.transcribe/coverage.svg?branch=master)](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") -``` - -``` -## Hi, everybody. I'm Randall, and I wanted to show off some -## of the new features the Amazon transcribe. I'm cool. Like -## Noelle with the cake quote. What do you do? I'm an -## engineer. I work for Boeing satellites. Whoa, that's -## awesome. Are you excited for Arena in 2019? Yes. I can't -## wait to meet everyone evades. Are you excited for the -## musical guest? Who is gonna be? I have no idea that I'm not -## sure. -``` - -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") -``` - - - ---- -[![cloudyr project logo](https://i.imgur.com/JHS98Y7.png)](https://github.com/cloudyr) +# R Client for the AWS Transcribe API + +[![CRAN](https://www.r-pkg.org/badges/version/aws.transcribe)](https://cran.r-project.org/package=aws.transcribe) +![Downloads](https://cranlogs.r-pkg.org/badges/aws.transcribe) +[![Travis Build Status](https://travis-ci.org/cloudyr/aws.transcribe.png?branch=master)](https://travis-ci.org/cloudyr/aws.transcribe) +[![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/PROJECTNUMBER?svg=true)](https://ci.appveyor.com/project/cloudyr/aws.transcribe) +[![codecov.io](https://codecov.io/github/cloudyr/aws.transcribe/coverage.svg?branch=master)](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") +``` + +``` +## Hi, everybody. I'm Randall, and I wanted to show off some +## of the new features the Amazon transcribe. I'm cool. Like +## Noelle with the cake quote. What do you do? I'm an +## engineer. I work for Boeing satellites. Whoa, that's +## awesome. Are you excited for Arena in 2019? Yes. I can't +## wait to meet everyone evades. Are you excited for the +## musical guest? Who is gonna be? I have no idea that I'm not +## sure. +``` + +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") +``` + + + +--- +[![cloudyr project logo](https://i.imgur.com/JHS98Y7.png)](https://github.com/cloudyr) From 10ff9788ad5a5b745f8e1b7316e823a8bb3b0a17 Mon Sep 17 00:00:00 2001 From: Simon Spavound Date: Sat, 13 Mar 2021 18:01:24 +0000 Subject: [PATCH 2/5] update start_transcription and documentation --- DESCRIPTION | 48 ++++++++--------- R/start_transcription.R | 106 +++++++++++++++++++++++-------------- man/start_transcription.Rd | 20 ++++++- 3 files changed, 109 insertions(+), 65 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index aa16166..ca12f3a 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,24 +1,24 @@ -Package: aws.transcribe -Type: Package -Title: Client for 'AWS Transcribe' -Version: 0.1.3.9000 -Date: 2020-03-10 -Authors@R: c(person("Thomas J.", "Leeper", - role = c("aut"), - email = "thosjleeper@gmail.com", - comment = c(ORCID = "0000-0003-4097-6326")), - person("Antoine", "Sachet", role = c("cre"), - email = "antoine.sac@gmail.com")) -Description: Client for 'AWS Transcribe' , a cloud transcription service that can convert an audio media file in English and other languages into a text transcript. -License: GPL (>= 2) -URL: https://github.com/cloudyr/aws.transcribe -BugReports: https://github.com/cloudyr/aws.transcribe/issues -Imports: - tools, - httr, - jsonlite, - aws.signature (>= 0.3.4) -Suggests: - testthat -Encoding: UTF-8 -RoxygenNote: 7.0.2 +Package: aws.transcribe +Type: Package +Title: Client for 'AWS Transcribe' +Version: 0.1.3.9000 +Date: 2020-03-10 +Authors@R: c(person("Thomas J.", "Leeper", + role = c("aut"), + email = "thosjleeper@gmail.com", + comment = c(ORCID = "0000-0003-4097-6326")), + person("Antoine", "Sachet", role = c("cre"), + email = "antoine.sac@gmail.com")) +Description: Client for 'AWS Transcribe' , a cloud transcription service that can convert an audio media file in English and other languages into a text transcript. +License: GPL (>= 2) +URL: https://github.com/cloudyr/aws.transcribe +BugReports: https://github.com/cloudyr/aws.transcribe/issues +Imports: + tools, + httr, + jsonlite, + aws.signature (>= 0.3.4) +Suggests: + testthat +Encoding: UTF-8 +RoxygenNote: 7.1.1 diff --git a/R/start_transcription.R b/R/start_transcription.R index fc3f6db..a0c4c86 100644 --- a/R/start_transcription.R +++ b/R/start_transcription.R @@ -1,40 +1,66 @@ -#' @title Start AWS Transcribe Job -#' @description Start an AWS Transcribe job -#' @param name A character string specifying a unique name for the transcription job. -#' @param url A character string specifying a URL for the media file to be transcribed. -#' @param format A character string specifying the file format. One of: \dQuote{mp3}, \dQuote{mp4}, \dQuote{wav}, \dQuote{flac}. -#' @param language A character string specifying a language code. Currently defaults to \dQuote{en-US}. -#' @param hertz Optionally, a numeric value specifying sample rate in Hertz. -#' @param \dots Additional arguments passed to \code{\link{transcribeHTTP}}. -#' @return A list containing details of the job. The transcript can be retrieved with \code{\link{get_transcription}}. -#' @examples -#' \dontrun{ -#' # start a transcription -#' ## upload a file to S3 -#' library("aws.s3") -#' put_object(file = "recording.mp3", bucket = "my-bucket", object = "recording.mp3") -#' -#' ## start trancription -#' start_transcription("first-example", "https://my-bucket.us-east-1.amazonaws.com/recording.mp3") -#' } -#' @seealso \code{\link{get_transcription}} -#' @importFrom tools file_ext -#' @export -start_transcription <- -function( - name, - url, - format = tools::file_ext(url), - language = "en-US", - hertz = NULL, - ... -) { - bod <- list(Media = list(MediaFileUri = url)) - bod$MediaFormat <- format - bod$LanguageCode <- language - if (!is.null(hertz)) { - bod$MediaSampleRateHertz <- hertz - } - bod$TranscriptionJobName <- name - transcribeHTTP(action = "StartTranscriptionJob", body = bod, ...) -} +#' @title Start AWS Transcribe Job +#' @description Start an AWS Transcribe job +#' +#' @param name A character string specifying a unique name for the transcription job. +#' @param url A character string specifying a URL for the media file to be transcribed. +#' @param format A character string specifying the file format. One of: \dQuote{mp3}, \dQuote{mp4}, \dQuote{wav}, \dQuote{flac}. +#' @param language A character string specifying a language code. Currently defaults to \dQuote{en-US}. +#' @param hertz Optionally, a numeric value specifying sample rate in Hertz. +#' @param output_bucket Optionally, a character string specifying the output bucket to place the results of the Amazon Transcribe job in. +#' @param channel_identification Optionally, a boolean which instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription. Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription. You can't set both \code{show_speaker_labels} and \code{channel_identification} in the same request. +#' @param show_speaker_labels Optionally, a boolean specifying whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the \code{show_speaker_labels} field to true, you must also set the maximum number of speaker labels \code{max_speaker_labels} field. +#' @param max_speaker_labels Optionally, an integer specifying the maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the \code{max_speaker_labels} field, you must set the \code{show_speaker_labels} field to \code{TRUE}. Valid Range: Minimum value of 2. Maximum value of 10. +#' @param vocabulary_name Optionally, a character string specifying the name of a vocabulary to use when processing the transcription job. +#' @param more_settings Optionally, a list of additional settings to be passed to Amazon Transcribe. +#' @param \dots Additional arguments passed to \code{\link{transcribeHTTP}}. +#' +#' @return A list containing details of the job. The transcript can be retrieved with \code{\link{get_transcription}}. +#' @examples +#' \dontrun{ +#' # start a transcription +#' ## upload a file to S3 +#' library("aws.s3") +#' put_object(file = "recording.mp3", bucket = "my-bucket", object = "recording.mp3") +#' +#' ## start transcription +#' start_transcription("first-example", "https://my-bucket.us-east-1.amazonaws.com/recording.mp3") +#' } +#' @seealso \code{\link{get_transcription}} +#' @importFrom tools file_ext +#' @export +start_transcription <- +function( + name, + url, + format = tools::file_ext(url), + language = "en-US", + hertz = NULL, + output_bucket = NULL, + channel_identification = NULL, + show_speaker_labels = NULL, + max_speaker_labels = NULL, + vocabulary_name = NULL, + more_settings = list(), + ... +) { + bod <- list(Media = list(MediaFileUri = url)) + bod$MediaFormat <- format + bod$LanguageCode <- language + bod$MediaSampleRateHertz <- hertz + bod$TranscriptionJobName <- name + bod$OutputBucketName <- output_bucket + + stopifnot(is.list(more_settings)) + settings <- more_settings + + settings$ChannelIdentification <- channel_identification + settings$ShowSpeakerLabels <- show_speaker_labels + settings$MaxSpeakerLabels <- max_speaker_labels + settings$VocabularyName <- vocabulary_name + + if (length(settings)) { + bod$Settings <- settings + } + + transcribeHTTP(action = "StartTranscriptionJob", body = bod, ...) +} \ No newline at end of file diff --git a/man/start_transcription.Rd b/man/start_transcription.Rd index bc55ca5..dc308d1 100644 --- a/man/start_transcription.Rd +++ b/man/start_transcription.Rd @@ -10,6 +10,12 @@ start_transcription( format = tools::file_ext(url), language = "en-US", hertz = NULL, + output_bucket = NULL, + channel_identification = NULL, + show_speaker_labels = NULL, + max_speaker_labels = NULL, + vocabulary_name = NULL, + more_settings = list(), ... ) } @@ -24,6 +30,18 @@ start_transcription( \item{hertz}{Optionally, a numeric value specifying sample rate in Hertz.} +\item{output_bucket}{Optionally, a character string specifying the output bucket to place the results of the Amazon Transcribe job in.} + +\item{channel_identification}{Optionally, a boolean which instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription. Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription. You can't set both \code{show_speaker_labels} and \code{channel_identification} in the same request.} + +\item{show_speaker_labels}{Optionally, a boolean specifying whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the \code{show_speaker_labels} field to true, you must also set the maximum number of speaker labels \code{max_speaker_labels} field.} + +\item{max_speaker_labels}{Optionally, an integer specifying the maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the \code{max_speaker_labels} field, you must set the \code{show_speaker_labels} field to \code{TRUE}. Valid Range: Minimum value of 2. Maximum value of 10.} + +\item{vocabulary_name}{Optionally, a character string specifying the name of a vocabulary to use when processing the transcription job.} + +\item{more_settings}{Optionally, a list of additional settings to be passed to Amazon Transcribe.} + \item{\dots}{Additional arguments passed to \code{\link{transcribeHTTP}}.} } \value{ @@ -39,7 +57,7 @@ Start an AWS Transcribe job library("aws.s3") put_object(file = "recording.mp3", bucket = "my-bucket", object = "recording.mp3") -## start trancription +## start transcription start_transcription("first-example", "https://my-bucket.us-east-1.amazonaws.com/recording.mp3") } } From a32d17e9260997944ad62590fcc89664d0c66f4f Mon Sep 17 00:00:00 2001 From: Simon Spavound Date: Sat, 13 Mar 2021 18:08:31 +0000 Subject: [PATCH 3/5] update DESCRIPTION pre PR --- DESCRIPTION | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index ca12f3a..9fca2db 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,13 +2,15 @@ Package: aws.transcribe Type: Package Title: Client for 'AWS Transcribe' Version: 0.1.3.9000 -Date: 2020-03-10 +Date: 2021-03-13 Authors@R: c(person("Thomas J.", "Leeper", role = c("aut"), email = "thosjleeper@gmail.com", comment = c(ORCID = "0000-0003-4097-6326")), person("Antoine", "Sachet", role = c("cre"), - email = "antoine.sac@gmail.com")) + email = "antoine.sac@gmail.com"), + person("Simon", "Spavound", role = c("ctb"), + email = "simon.spavound@googlemail.com")) Description: Client for 'AWS Transcribe' , a cloud transcription service that can convert an audio media file in English and other languages into a text transcript. License: GPL (>= 2) URL: https://github.com/cloudyr/aws.transcribe From e804551028cf4ded499130ffe90315ea776231cb Mon Sep 17 00:00:00 2001 From: Simon Spavound Date: Sat, 13 Mar 2021 18:15:29 +0000 Subject: [PATCH 4/5] update news --- NEWS.md | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/NEWS.md b/NEWS.md index bb04001..d3d3183 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,14 +1,18 @@ -# aws.transcribe (development version) - -# aws.transcribe 0.1.3 - -* Released on CRAN 2020-03-11 -* New maintainer @antoine-sachet - -# aws.transcribe 0.1.2 - -* Finish minimum working example. - -# aws.transcribe 0.1.1 - -* Initial release. +# aws.transcribe (development version) + +# aws.transcribe 0.1.4 + +* Added optional arguments to `start_transcription()` + +# aws.transcribe 0.1.3 + +* Released on CRAN 2020-03-11 +* New maintainer @antoine-sachet + +# aws.transcribe 0.1.2 + +* Finish minimum working example. + +# aws.transcribe 0.1.1 + +* Initial release. From ce49319f28f25bd87ef6f509f0afe8c6e8f910c4 Mon Sep 17 00:00:00 2001 From: Simon Spavound Date: Sat, 13 Mar 2021 18:18:25 +0000 Subject: [PATCH 5/5] final checks pre PR --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 9fca2db..2e6d5e1 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: aws.transcribe Type: Package Title: Client for 'AWS Transcribe' -Version: 0.1.3.9000 +Version: 0.1.4.0000 Date: 2021-03-13 Authors@R: c(person("Thomas J.", "Leeper", role = c("aut"),