Skip to content

Commit

Permalink
📦 prepare release v2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Stefano Coretta committed Apr 23, 2019
1 parent 71008b0 commit b48e832
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 11 deletions.
5 changes: 3 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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 = "[email protected]",
role = c("aut", "cre"))
Description: It allows running Praat scripts from R and it provides some
Expand All @@ -17,3 +17,4 @@ Suggests: knitr,
tidyverse,
rmarkdown
VignetteBuilder: knitr
Language: en_GB
5 changes: 3 additions & 2 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Change Log

## Unreleased
## [2.1.0] - 2019-04-23
### Changed
- expanded documentation

Expand Down Expand Up @@ -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
4 changes: 2 additions & 2 deletions R/paths.R
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")`.
Expand All @@ -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.
2 changes: 1 addition & 1 deletion man/lmt_path.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/praat_path.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/run-praat.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit b48e832

Please sign in to comment.