Import spline data

The function read_aaa() can quickly import spline data and transform it into the long format (where each observation is a point on a fan line and the coordinates values are two variables, X and Y, see ?tongue for more details).

To correctly import AAA data, it is required that the file exported from AAA does not contain the header. This must be supplied as an argument to the read_aaa() function. We thus create a character vector with a concatenation of column names as strings.

columns <- c(
    "speaker",
    "seconds",
    "rec_date",
    "prompt",
    "label",
    "TT_displacement",
    "TT_velocity",
    "TT_abs_velocity",
    "TD_displacement",
    "TD_velocity",
    "TD_abs_velocity"
)

Now we can use read_aaa() to import the spline data as a tibble. The function requires a string with the file path and name, and a vector with the names of the columns.

# system.file() is needed here because the example files reside in the package.
# You can just include the file path directly in read_aaa, like 
# read_aaa("~/Desktop/splines.tsv", columns)
file_path <- system.file("extdata", "it01.tsv", package = "rticulate")

tongue <- read_aaa(file_path, columns)

## Rows: 11 Columns: 95
## ── Column specification ────────────────────────────────────────────────────────
## Delimiter: "\t"
## chr  (4): speaker, rec_date, prompt, label
## dbl (91): seconds, TT_displacement, TT_velocity, TT_abs_velocity, TD_displac...
## 
## ℹ Use `spec()` to retrieve the full column specification for this data.
## ℹ Specify the column types or set `show_col_types = FALSE` to quiet this message.

To check the head of the tibble, just do:

tongue

## # A tibble: 462 × 15
##    speaker seconds rec_date prompt label TT_di…¹ TT_ve…² TT_ab…³ TD_di…⁴ TD_ve…⁵
##    <chr>     <dbl> <chr>    <chr>  <chr>   <dbl>   <dbl>   <dbl>   <dbl>   <dbl>
##  1 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  2 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  3 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  4 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  5 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  6 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  7 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  8 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  9 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
## 10 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
## # … with 452 more rows, 5 more variables: TD_abs_velocity <dbl>,
## #   fan_line <int>, X <dbl>, Y <dbl>, .index <int>, and abbreviated variable
## #   names ¹​TT_displacement, ²​TT_velocity, ³​TT_abs_velocity, ⁴​TD_displacement,
## #   ⁵​TD_velocity

Sometimes is useful to add extra information for each prompt (like vowel, consonant place, phonation, etc.). We can do so by using functions from the dplyr package (word() is from the stringr package).

stimuli <- read_csv(system.file("extdata", "stimuli.csv", package = "rticulate"))

## Rows: 12 Columns: 11
## ── Column specification ────────────────────────────────────────────────────────
## Delimiter: ","
## chr (10): word, ipa, c1, c1_phonation, vowel, anteropost, height, c2, c2_pho...
## dbl  (1): item
## 
## ℹ Use `spec()` to retrieve the full column specification for this data.
## ℹ Specify the column types or set `show_col_types = FALSE` to quiet this message.

tongue <- mutate(tongue, word = word(prompt, 2)) %>%
    left_join(y = stimuli) %>%
    mutate_if(is.character, as.factor)

## Joining, by = "word"

Let’s check tongue again.

tongue

## # A tibble: 462 × 26
##    speaker seconds rec_date prompt label TT_di…¹ TT_ve…² TT_ab…³ TD_di…⁴ TD_ve…⁵
##    <fct>     <dbl> <fct>    <fct>  <fct>   <dbl>   <dbl>   <dbl>   <dbl>   <dbl>
##  1 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  2 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  3 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  4 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  5 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  6 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  7 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  8 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
##  9 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
## 10 it01       1.20 29/11/2… Dico … max_…    77.9   -7.73    5.10    67.3   -34.3
## # … with 452 more rows, 16 more variables: TD_abs_velocity <dbl>,
## #   fan_line <int>, X <dbl>, Y <dbl>, .index <int>, word <fct>, item <dbl>,
## #   ipa <fct>, c1 <fct>, c1_phonation <fct>, vowel <fct>, anteropost <fct>,
## #   height <fct>, c2 <fct>, c2_phonation <fct>, c2_place <fct>, and abbreviated
## #   variable names ¹​TT_displacement, ²​TT_velocity, ³​TT_abs_velocity,
## #   ⁴​TD_displacement, ⁵​TD_velocity

Plot splines

To plot splines from a spline data frame, use plot_tongue(). This function is a wrapper of a ggplot call (from the ggplot2 package). The coordinates must be in two variables named X and Y. read_aaa() creates them automatically while importing the raw data.

plot_tongue(tongue)

## `geom_smooth()` using formula 'y ~ x'

You can also easily filter the tibble with the filter() function from dplyr.

filter(tongue, label == "max_TD") %>%
    plot_tongue()

## `geom_smooth()` using formula 'y ~ x'

You can specify geom options and aesthetics in the usual ggplot way (remember to load the package with library(ggplot2) if you need this). geom options are arguments of plot_tongue(), while aesthetics can be called with aes().

plot_tongue(tongue, alpha = 0.5) +
    aes(group = rec_date, colour = c2_place) +
    theme(legend.position = "bottom")

## `geom_smooth()` using formula 'y ~ x'

To plot points instead of splines, use plot_tongue(geom = "point").

plot_tongue(tongue, geom = "point", alpha = 0.5) +
    aes(group = rec_date, colour = c2_place) +
    theme(legend.position = "bottom")

Finally, if you want to plot the palate profile, you can do so by specifying a data frame with the coordinates for the palate spline.

palate <- read_aaa(system.file("extdata", "it01-palate.tsv", package = "rticulate"), columns)

## Warning: One or more parsing issues, see `problems()` for details

## Rows: 1 Columns: 95
## ── Column specification ────────────────────────────────────────────────────────
## Delimiter: "\t"
## chr  (3): speaker, rec_date, prompt
## dbl (55): seconds, TT_displacement, TT_velocity, TT_abs_velocity, TD_displac...
## lgl (37): label, X_1, Y_1, X_2, Y_2, X_3, Y_3, X_4, Y_4, X_5, Y_5, X_6, Y_6,...
## 
## ℹ Use `spec()` to retrieve the full column specification for this data.
## ℹ Specify the column types or set `show_col_types = FALSE` to quiet this message.

filter(tongue, label == "max_TD") %>%
    plot_tongue(palate = palate, alpha = 0.5) + aes(group = rec_date)

## `geom_smooth()` using formula 'y ~ x'
## `geom_smooth()` using formula 'y ~ x'

## Warning: Removed 18 rows containing non-finite values (stat_smooth).

Import multiple files

To import multiple files with AAA data, simply use a list of paths with read_aaa, for example using list.files.

tongue2 <- list.files(
    path = system.file("extdata", package = "rticulate"),
    pattern = "*\\d.tsv",
    full.names = TRUE
    ) %>%
    read_aaa(., columns)

## Rows: 11 Columns: 95
## ── Column specification ────────────────────────────────────────────────────────
## Delimiter: "\t"
## chr  (4): speaker, rec_date, prompt, label
## dbl (91): seconds, TT_displacement, TT_velocity, TT_abs_velocity, TD_displac...
## 
## ℹ Use `spec()` to retrieve the full column specification for this data.
## ℹ Specify the column types or set `show_col_types = FALSE` to quiet this message.
## Rows: 8 Columns: 95
## ── Column specification ────────────────────────────────────────────────────────
## Delimiter: "\t"
## chr  (4): speaker, rec_date, prompt, label
## dbl (91): seconds, TT_displacement, TT_velocity, TT_abs_velocity, TD_displac...
## 
## ℹ Use `spec()` to retrieve the full column specification for this data.
## ℹ Specify the column types or set `show_col_types = FALSE` to quiet this message.

We can now plot splines for both speakers.

plot_tongue(tongue2, alpha = 0.5) +
    aes(group = rec_date) +
    facet_grid(. ~ speaker)

## `geom_smooth()` using formula 'y ~ x'