speakr

speakr: A Wrapper for the Phonetic Software Praat

https://github.com/stefanocoretta/speakr

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
✓
DOI references
Found 1 DOI reference(s) in README
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.1%) to scientific vocabulary

Keywords

package praat praatscript r r-package rstats software

Last synced: 6 months ago · JSON representation

Repository

speakr: A Wrapper for the Phonetic Software Praat

Basic Info

Host: GitHub
Owner: stefanocoretta
License: other
Language: R
Default Branch: main
Homepage: https://stefanocoretta.github.io/speakr/
Size: 1.8 MB

Statistics

Stars: 25
Watchers: 2
Forks: 3
Open Issues: 4
Releases: 13

Topics

package praat praatscript r r-package rstats software

Created about 9 years ago · Last pushed 12 months ago

Metadata Files

Readme Changelog License

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
library(readr)
library(ggplot2)
library(magrittr)
theme_set(theme_minimal())
library(speakr)
```

# speakr: A Wrapper for the Phonetic Software Praat 


`r badger::badge_doi(doi = "10.5281/zenodo.4014768", color = "blue")`
`r badger::badge_cran_release("speakr", "blue")`
`r badger::badge_cran_checks("speakr")`
`r badger::badge_devel(color = "orange")`


With speakr, you can run Praat scripts in R and capture their `infoLine` output.

## Installation

You can install the released version of speakr from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("speakr")
```

If you want to install a stable(ish) development version, use:

``` r
remotes::install_github("stefanocoretta/speakr@devel", build_vignettes = TRUE)
```

## Use

For a quick start, check out the vignette with:

``` r
vignette("run-praat", "speakr")
```

On macOS, Linux and Windows, the path to praat is set automatically to the default installation path.
If you have installed Praat in a different location, or if your operating system is not supported, you can set the path to Praat with `options(speakr.praat.path)`.

For example:

``` r
options(speakr.praat.path = "./custom/praat.exe")
```

You can either run this command every time you start a new R session, or you can add the command to your `.Rprofile` (recommended).

## Example

Use `prat_run()` to run a Praat script, and `capture = TRUE` to capture the output of the `write/appendInfoLine` commands in the script.
Everything is set in the Praat script as usual, so you don't have to learn a new language to perform tasks you already know how to perform.

```{r run-script}
script <- system.file("extdata", "get-formants-args.praat", package = "speakr")

formants <- praat_run(script, "Hertz", 0.03, capture = TRUE) %>%
  read_csv()
```

Let's check the tibble `formants`.

```{r formants}
formants
```

And let's make a vowel plot.

```{r vowel-plot}
formants %>%
  ggplot(aes(F2, F1, label = vowel)) +
  geom_label(size = 10) +
  labs(
    title = "Vowel plot",
    x = "F2 (Hertz)",
    y = "F1 (Hertz)"
  ) +
  scale_x_reverse(position = "top", limits = c(2250, 700)) +
  scale_y_reverse(position = "right", limits = c(900, 150)) +
  coord_fixed()
```

## Simple plotting utility

You can plot a sound file and TextGrid using Praat's plotting facilities.

```{r plotting, eval=FALSE}
wav <- system.file("extdata", "vowels.wav", package = "speakr")

praat_plot("vowels.png", wav, f0 = T, f0_max = 200, end = 3)
```

You can include the plot in an Rmarkdown file with knitr.

```{r fig}
knitr::include_graphics("man/figures/README-vowel-plot-1.png")
```

Owner

Name: Stefano Coretta
Login: stefanocoretta
Kind: user
Location: Edinburgh
Company: University of Edinburgh

Website: https://stefanocoretta.github.io
Twitter: StefanoCoretta
Repositories: 126
Profile: https://github.com/stefanocoretta

I am a Lecturer (Assistant Professor) in the Linguistics and English Language department of the University of Edinburgh

GitHub Events

Total

Release event: 1
Watch event: 1
Delete event: 1
Issue comment event: 2
Push event: 9
Create event: 1

Last Year

Release event: 1
Watch event: 1
Delete event: 1
Issue comment event: 2
Push event: 9
Create event: 1

Committers

Last synced: over 2 years ago

All Time

Total Commits: 133
Total Committers: 3
Avg Commits per committer: 44.333
Development Distribution Score (DDS): 0.466

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stefanocoretta	s**a@g**m	71
Stefano Coretta	s**l@m**m	61
Jim Hester	j**r@g**m	1

Committer Domains (Top 20 + Academic)

me.com: 1

Issues and Pull Requests

Last synced: over 2 years ago

All Time

Total issues: 9
Total pull requests: 2
Average time to close issues: 12 days
Average time to close pull requests: 6 days
Total issue authors: 3
Total pull request authors: 2
Average comments per issue: 0.33
Average comments per pull request: 1.5
Merged pull requests: 2
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

stefanocoretta (7)
JackGuo15 (1)
FredrikKarlssonSpeech (1)
purlubru (1)

Pull Request Authors

jimhester (1)
agricolamz (1)

Top Labels

Issue Labels

bug (2) enhancement (2)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 383 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 7
Total maintainers: 1

cran.r-project.org: speakr

A Wrapper for the Phonetic Software 'Praat'

Homepage: https://github.com/stefanocoretta/speakr
Documentation: http://cran.r-project.org/web/packages/speakr/speakr.pdf
License: MIT + file LICENSE
Latest release: 3.2.4
published about 1 year ago

Versions: 7
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 383 Last month

Rankings

Stargazers count: 11.9%

Forks count: 14.9%

Average: 28.7%

Dependent packages count: 29.8%

Dependent repos count: 35.5%

Downloads: 51.5%

Maintainers (1)

stefano.coretta@gmail.com

Last synced: 6 months ago

Dependencies

DESCRIPTION cran

ggplot2 * imports
lifecycle * imports
readr * imports
stringr * imports
tibble * imports
knitr * suggests
rmarkdown * suggests

.github/workflows/R-CMD-check.yaml actions

actions/checkout v3 composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/pkgdown.yaml actions

JamesIves/github-pages-deploy-action v4.4.1 composite
actions/checkout v3 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite
r-lib/actions/setup-renv v2 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

speakr

Science Score: 26.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.Rmd

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: speakr

Rankings

Maintainers (1)

Dependencies