diff --git a/DESCRIPTION b/DESCRIPTION index 444ca87..f7eedf3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Package: speakr Type: Package Title: A Wrapper for the Phonetic Software Praat -Version: 2.0.1.9000 -Date: 2019-03-27 +Version: 2.1.0 +Date: 2019-04-23 Authors@R: person("Stefano", "Coretta", email = "stefano.coretta@gmail.com", role = c("aut", "cre")) Description: It allows running Praat scripts from R and it provides some @@ -17,3 +17,4 @@ Suggests: knitr, tidyverse, rmarkdown VignetteBuilder: knitr +Language: en_GB diff --git a/NEWS.md b/NEWS.md index 9a6cb9c..2197ac4 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,6 @@ # Change Log -## Unreleased +## [2.1.0] - 2019-04-23 ### Changed - expanded documentation @@ -28,12 +28,13 @@ - code style of some functions ### Removed -- old functions with cameCase names +- old functions with camelCase names ## 1.0.0 ### Added - everything +[2.1.0]: https://github.com/stefanocoretta/speakr/compare/v2.0.2...v2.1.0 [2.0.2]: https://github.com/stefanocoretta/speakr/compare/v2.0.1...v2.0.2 [2.0.1]: https://github.com/stefanocoretta/speakr/compare/v2.0.0...v2.0.1 [2.0.0]: https://github.com/stefanocoretta/speakr/compare/v1.0.0...v2.0.0 diff --git a/R/paths.R b/R/paths.R index e923e88..cd3dce0 100644 --- a/R/paths.R +++ b/R/paths.R @@ -1,6 +1,6 @@ #' Get system path to Praat. #' -#' The function returns the path to the Praat executable depeding on the +#' The function returns the path to the Praat executable depending on the #' system. #' #' @return The path to the Praat executable. @@ -44,7 +44,7 @@ get_praat_path <- function() { #' Get system path to lmt. #' -#' The function returns the path to the lmt executable depeding on the +#' The function returns the path to the lmt executable depending on the #' system. #' #' @return The path to the lmt executable. diff --git a/README.md b/README.md index 8c19f25..4b26865 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This is the repository of `speakr`, an `R` package for running Praat scripts and ## Installation -To install `speakr`, use `devtools::install_github("stefanocoretta/speakr@v2.0.2", build_opts = c("--no-resave-data", "--no-manual"))`. For a quick start on how to use the package, check out the vignette with `vignette("run-praat", "speakr")`. +To install `speakr`, use `devtools::install_github("stefanocoretta/speakr@v2.1.0", build_opts = c("--no-resave-data", "--no-manual"))`. For a quick start on how to use the package, check out the vignette with `vignette("run-praat", "speakr")`. If you want to tangle the code of your Praat script with the literate markdown tangler, you need to also install `lmt` from [here](https://github.com/driusan/lmt). To use `lmt` with `speakr`, your Go workspace (which will contain the `lmt` executable) needs to be in the default location (`$HOME/go` in Unix and `%USERPROFILE%/go` in Windows). If you are using a custom workspace location, you can set the custom path to `lmt` with `set_lmt_path()` at the start of every R session. Check how to use `speakr::lmt()` by running `vignette("literate-praat", "speakr")`. @@ -15,6 +15,6 @@ For a demo, check [this repo](https://github.com/stefanocoretta/speakr-demo). ## Disclaimer -The current stable (🐛 free) version is `v2.0.2`. +The current stable (🐛 free) version is `v2.01.0. Package versions ending with `.9000` are developmental. Things might break when updating to the development version. diff --git a/man/lmt_path.Rd b/man/lmt_path.Rd index eecdd32..c276f8c 100644 --- a/man/lmt_path.Rd +++ b/man/lmt_path.Rd @@ -10,7 +10,7 @@ lmt_path() The path to the lmt executable. } \description{ -The function returns the path to the lmt executable depeding on the +The function returns the path to the lmt executable depending on the system. } \keyword{internal} diff --git a/man/praat_path.Rd b/man/praat_path.Rd index 27169b5..820ad54 100644 --- a/man/praat_path.Rd +++ b/man/praat_path.Rd @@ -10,7 +10,7 @@ praat_path() The path to the Praat executable. } \description{ -The function returns the path to the Praat executable depeding on the +The function returns the path to the Praat executable depending on the system. } \keyword{internal} diff --git a/vignettes/run-praat.Rmd b/vignettes/run-praat.Rmd index 311cbee..a2fa961 100644 --- a/vignettes/run-praat.Rmd +++ b/vignettes/run-praat.Rmd @@ -31,7 +31,7 @@ If the script logs results to a file, the file is created in the same directory If, on the other hand, the script logs output to the Info window (for example by using `writeInfo` in the script), you can specify the argument `capture = TRUE` to capture the argument into an R character variable. The outputted string can then be read in as a data frame or tibble. -The following example runs the script `get-formants.praat`, which requires two arguments, `"Herz"` and `0.03` (these will be passed to the `form` in the script). The script logs the results to the Info window with `appendInfoLine` so we use `capture = TRUE` here to stransform the console output into a string and pipe it (`%>%`) to `read_csv()`. +The following example runs the script `get-formants.praat`, which requires two arguments, `"Herz"` and `0.03` (these will be passed to the `form` in the script). The script logs the results to the Info window with `appendInfoLine` so we use `capture = TRUE` here to transform the console output into a string and pipe it (`%>%`) to `read_csv()`. ```{r run} # system.file() is needed here because the example files reside in the package.