Type: Package
Title: Linguistic Phonetic Fieldwork Tools
Version: 0.0.17
Depends: R (≥ 3.5.0)
Imports: tuneR, phonTools, grDevices, utils, graphics, rmarkdown, xml2, readr, tools, mime
Description: There are a lot of different typical tasks that have to be solved during phonetic research and experiments. This includes creating a presentation that will contain all stimuli, renaming and concatenating multiple sound files recorded during a session, automatic annotation in 'Praat' TextGrids (this is one of the sound annotation standards provided by 'Praat' software, see Boersma & Weenink 2020 https://www.fon.hum.uva.nl/praat/), creating an html table with annotations and spectrograms, and converting multiple formats ('Praat' TextGrid, 'ELAN', 'EXMARaLDA', 'Audacity', subtitles '.srt', and 'FLEx' flextext). All of these tasks can be solved by a mixture of different tools (any programming language has programs for automatic renaming, and Praat contains scripts for concatenating and renaming files, etc.). 'phonfieldwork' provides a functionality that will make it easier to solve those tasks independently of any additional tools. You can also compare the functionality with other packages: 'rPraat' https://CRAN.R-project.org/package=rPraat, 'textgRid' https://CRAN.R-project.org/package=textgRid.
License: GPL-2 | GPL-3 [expanded from: GPL (≥ 2)]
SystemRequirements: pandoc (>= 1.14) - http://pandoc.org
URL: https://CRAN.R-project.org/package=phonfieldwork, https://docs.ropensci.org/phonfieldwork/
BugReports: https://github.com/ropensci/phonfieldwork/issues
Encoding: UTF-8
RoxygenNote: 7.3.2
VignetteBuilder: knitr
Suggests: knitr, tidyr, dplyr, DT, lingtypology, testthat, readxl
Language: en-US
NeedsCompilation: no
Packaged: 2024-07-29 17:16:24 UTC; agricolamz
Author: George Moroz ORCID iD [aut, cre], Jonathan Keane ORCID iD [rev], Niko Partanen ORCID iD [rev], Valeria Buntiakova ORCID iD [ctb]
Maintainer: George Moroz <agricolamz@gmail.com>
Repository: CRAN
Date/Publication: 2024-07-29 17:40:02 UTC

Create indices padded with zeros

Description

Create indices padded with zeros. This is important for creating appropriate for sorting names.

Usage

add_leading_symbols(file_names)

Arguments

file_names

vector of any values.

Value

A string with numbers padded with leadinng zero.

Author(s)

George Moroz <agricolamz@gmail.com>

Annotate textgrid

Description

Annotates textgrids. It is possible to define step in the argument "each", so each second element of the tier will be annotated.

Usage

annotate_textgrid(
  annotation,
  textgrid,
  tier = 1,
  each = 1,
  backup = TRUE,
  write = TRUE
)

Arguments

annotation

vector of stimuli

textgrid

character with a filename or path to the TextGrid

tier

value that could be either ordinal number of the tier either name of the tier

each

non-negative integer. Each element of x is repeated each times

backup

logical. If TRUE (by default) it creates a backup tier.

write

logical. If TRUE (by dafault) it overwrites an existing tier.

Value

a string that contain TextGrid. If argument write is TRUE, then no output.

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

annotate_textgrid(
  annotation = c("", "t", "e", "s", "t"),
  textgrid = system.file("extdata",
    "test.TextGrid",
    package = "phonfieldwork"
  ),
  tier = 2, write = FALSE
)

Audacity's labels to dataframe

Description

Audacity make it possible to annotate sound files with labels that can be exported as a .tsv file with .txt extension. This function convert result to dataframe.

Usage

audacity_to_df(file_name)

Arguments

file_name

file_name string with a filename or path to the .txt file produced by Audacity

Value

a dataframe with columns: content, time_start, time_end, source.

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

audacity_to_df(system.file("extdata",
  "test_audacity.txt",
  package = "phonfieldwork"
))

Concatenate sounds

Description

Creates a merged sound file from old sound files in a folder. If the annotation argument is not equal to NULL, it creates an annotation file (Praat .TextGrid, ELAN .eaf or EXMARaLDA .exb) with original sound names annotation.

Usage

concatenate_soundfiles(
  path,
  result_file_name = "concatenated",
  annotation = "textgrid",
  separate_duration = 0
)

Arguments

path

path to the directory with soundfiles.

result_file_name

name of the result and annotation files.

annotation

character. There are several variants: "textgrid" for Praat TextGrid, "eaf" for ELAN's .eaf file, or "exb" for EXMARaLDA's .exb file. It is also possible to use NULL in order to prevent the creation of the annotation file.

separate_duration

double. It is possible to add some silence between concatenated sounds. This variable denotes duration of this soundless separator in seconds.

Value

no output

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

# create two files in a temprary folder "test_folder"
s1 <- system.file("extdata", "test.wav", package = "phonfieldwork")
s2 <- system.file("extdata", "post.wav", package = "phonfieldwork")
tdir <- tempdir()
file.copy(c(s1, s2), tdir)

# here are two .wav files in a folder
list.files(tdir)
# [1] "post.wav" "test.wav" ...

# Concatenate all files from the folder into concatenated.wav and create
# corresponding TextGrid
concatenate_soundfiles(path = tdir, result_file_name = "concatenated")

list.files(tdir)
# [1] "concatenated.TextGrid" "concatenated.wav" "post.wav" "test.wav" ...

Concatenate TextGrids

Description

Creates a merged TextGrids from TextGrids files in a folder.

Usage

concatenate_textgrids(path, result_file_name = "concatenated")

Arguments

path

path to the directory with soundfiles.

result_file_name

name of the result and annotation files.

Value

no output

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

# create two files in a temprary folder "test_folder"
t1 <- system.file("extdata", "test.TextGrid", package = "phonfieldwork")
t2 <- system.file("extdata", "post.TextGrid", package = "phonfieldwork")
tdir <- tempdir()
file.copy(c(t1, t2), tdir)

# here are two .wav files in a folder
list.files(tdir)
# [1] "post.TextGrid" "test.TextGrid" ...

# Concatenate all TextGrids from the folder into concatenated.TextGrid
concatenate_textgrids(path = tdir, result_file_name = "concatenated")

list.files(tdir)
# [1] "concatenated.TextGrid" "post.TextGrid" "test.TextGrid" ...

Create an empty TextGrid

Description

Creates an empty Praat TextGrid in the same folder as a reference sound file. It is possible to manage with predefined number of tiers, their names and their types.

Usage

create_empty_textgrid(
  duration,
  tier_name = NULL,
  point_tier = NULL,
  path,
  result_file_name = "new_textgrid"
)

Arguments

duration

integer. Duration of the textgrid. If you do not know the duration of your audio file use the get_sound_duration() function.

tier_name

a vector that contain tier names.

point_tier

a vector that defines which tiers should be made point tiers. This argument excepts numeric values (e. g. c(2, 4) means second and forth tiers) or character (e. g. c("a", "b") means tiers with names "a" and "b")

path

path to the directory with soundfiles.

result_file_name

name of the result and annotation files.

Value

The function returns no output, just creates a Praat TextGrid in the same folder as a reference sound file.

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

tmp <- tempfile(fileext = ".TextGrid")
create_empty_textgrid(1, path = dirname(tmp), result_file_name = basename(tmp))

Create a glossed document

Description

Creates a file with glossed example (export from .flextext or other formats)

Usage

create_glossed_document(
  flextext = NULL,
  rows = c("gls"),
  output_dir,
  output_file = "glossed_document",
  output_format = "html",
  example_pkg = NULL
)

Arguments

flextext

path to a .flextext file or a dataframe with the following columns: p_id, s_id, w_id, txt, cf, hn, gls, msa, morph, word, phrase, paragraph, free_trans, text, text_title

rows

vector of row names from the flextext that should appear in the final document. Possible values are: "cf", "hn", "gls", "msa". "gls" is default.

output_dir

the output directory for the rendered file

output_file

the name of the result .html file (by default glossed_document).

output_format

The option can be "html" or "docx"

example_pkg

vector with name of the LaTeX package for glossing (possible values: "gb4e", "langsci", "expex", "philex")

Value

If render is FALSE, the function returns a path to the temporary file with .csv file. If render is TRUE, there is no output in a function.

Author(s)

George Moroz <agricolamz@gmail.com>

Create image look_up objects for html viewer

Description

Create image look_up objects for html viewer

Usage

create_image_look_up(img_src, img_caption = NULL, text = "&#x1f441;")

Arguments

img_src

string or vector of strings with a image(s) path(s).

img_caption

string or vector of strings that will be displayed when image is clicked.

text

string o vector of strings that will be displayed as view link. By default it is eye emoji (&#x1f441;).

Value

a string or vector of strings

Author(s)

George Moroz <agricolamz@gmail.com>

Creates a presentation

Description

Creates an html or powerpoint presentation in a working directory from list of words and translations. Here is an example of such presentation.

Usage

create_presentation(
  stimuli,
  translations = "",
  external = NULL,
  font_size = 50,
  output_dir,
  output_format = "html",
  output_file = "stimuli_presentation",
  render = TRUE
)

Arguments

stimuli

the vector of stimuli (obligatory). Can be a path to an image.

translations

the vector of translations (optional)

external

the vector with the indices of external images

font_size

font size in px (50, by default)

output_dir

the output directory for the rendered file

output_format

the string that difine the R Markdown output format: "html" (by default) or "pptx"

output_file

the name of the result presentation file (by default stimuli_presentation)

render

the logical argument, if TRUE render the created R Markdown presentation to the output_dir folder, otherwise returns the path to the temporary file with a Rmd file.

Value

If render is FALSE, the function returns a path to the temporary file. If render is TRUE, there is no output in a function.

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

create_presentation(
  stimuli = c("rzeka", "drzewo"),
  translations = c("river", "tree"),
  render = FALSE
)

# with image
create_presentation(
  stimuli = c(
    "rzeka", "drzewo",
    system.file("extdata", "r-logo.png",
      package = "phonfieldwork"
    )
  ),
  translations = c("river", "tree", ""),
  external = 3,
  render = FALSE
)

Create audio play objects for html viewer

Description

Create audio play objects for html viewer

Usage

create_sound_play(snd_src, text = "&#x1f442;")

Arguments

snd_src

string or vector of strings with a image(s) path(s).

text

string o vector of strings that will be displayed as view link. By default it is ear emoji (&#x1f442;).

Value

a string or vector of strings

Author(s)

George Moroz <agricolamz@gmail.com>

Create boundaries in a texgrid tier

Description

Create boundaries in a texgrid tier

Usage

create_subannotation(
  textgrid,
  tier = 1,
  new_tier_name = "",
  n_of_annotations = 4,
  each = 1,
  omit_blank = TRUE,
  overwrite = TRUE
)

Arguments

textgrid

character with a filename or path to the TextGrid

tier

value that could be either ordinal number of the tier either name of the tier

new_tier_name

a name of a new created tier

n_of_annotations

number of new annotations per annotation to create

each

non-negative integer. Each new blank annotation is repeated every first, second or ... times

omit_blank

logical. If TRUE (by dafault) it doesn't create subannotation for empy annotations.

overwrite

logical. If TRUE (by dafault) it overwrites an existing tier.

Value

a string that contain TextGrid. If argument write is TRUE, then no output.

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

create_subannotation(system.file("extdata", "test.TextGrid",
  package = "phonfieldwork"
),
tier = 1, overwrite = FALSE
)

Create an annotation viewer

Description

Creates an html file with table and sound preview and player

Usage

create_viewer(
  audio_dir,
  picture_dir = NULL,
  table,
  captions = NULL,
  sorting_columns = NULL,
  about = "Created with the `phonfieldworks` package (Moroz 2020).",
  map = FALSE,
  output_dir,
  output_file = "stimuli_viewer",
  render = TRUE
)

Arguments

audio_dir

path to the directory with sounds

picture_dir

path to the directory with pictures

table

data frame with data ordered according to files in the audio folder

captions

vector of strings that will be used for captions for a picture.

sorting_columns

vector of strings for sorting the result column

about

it is either .Rmd file or string with the text for about information: author, project, place of gahtered information and other metadata, version of the viewer and so on

map

the logical argument, if TRUE and there is a glottocode column in table

output_dir

the output directory for the rendered file

output_file

the name of the result .html file (by default stimuli_viewer)

render

the logical argument, if TRUE renders the created R Markdown viewer to the output_dir folder, otherwise returns the path to the temporary file with a .csv file.

Value

If render is FALSE, the function returns a path to the temporary file with .csv file. If render is TRUE, there is no output in a function.

Author(s)

George Moroz <agricolamz@gmail.com>

Dataframe to .eaf

Description

Convert a dataframe to Elan file .exb

Usage

df_to_eaf(df, output_file, output_dir = "", ref_file = "", mime_type = "")

Arguments

df

an R dataframe object that contains columns named 'tier', 'id', 'tier_name', 'content', 'time_start', 'time_end' and preferably also 'tier_type', 'stereotype', 'tier_ref', 'event_local_id', 'dependent_on' that are specific for eaf file

output_file

the name of the result .xml file

output_dir

the output directory for the rendered file (defalut is used if not spectified)

ref_file

a filepath for connected media file (not obligatory)

mime_type

a MIME type of connected media file (not obligatory)

Value

.xml file

Author(s)

Sergej Kudrjashov <xenomirant@gmail.com>

Examples


df <- eaf_to_df(system.file("extdata", "test.eaf", package = "phonfieldwork"))

df_to_eaf(df = df,
          output_file = 'test.eaf',
          ref_file = 'test.wav')

# Remove file in order to pass checks

file.remove("test.eaf")

Dataframe to EXMARaLDA's .exb

Description

Convert a dataframe to EXMARaLDA's .exb

Usage

df_to_exb(
  df,
  name,
  output_file,
  output_dir = "",
  referenced_file = "",
  ud_meta = NULL,
  speaker_table = NULL
)

Arguments

df

an R dataframe object that contains columns named 'tier', 'tier_name', 'content', 'time_start', 'time_end' and 'id'

name

transcription name

output_file

the name of the result .html file

output_dir

the output directory for the rendered file

referenced_file

a filepath for .wav

ud_meta

a vector ('key':'value') of meta information (not obligatory)

speaker_table

a table with speaker information; must include columns 'id', 'abbreviation', 'sex' (not obligatory)

Value

.xml file

Author(s)

Valeria Buntiakova <valleriabun@gmail.com>

Examples

meta <- c('Type of communication' = 'Fernsehinterview',
          'Source' = 'Parkinson Talkshow auf BBC',
          'Background information' = 'Interview mit den Beckhams',
          'Code' = 'Beckhams')

speaker_data <- data.frame('id' = c('SPK0', 'SPK1', 'SPK2'),
                           'abbreviation' = c('PAR', 'VIC', 'DAV'),
                           'sex' = c('m', 'f', 'm'),
                           'Family: Marital status' = c('Verheiratet',
                                                        'Verheiratet',
                                                        'Verheiratet'),
                           'Birth' = c('28. März 1935 in Cudworth',
                                       '14. April 1974 in Hertfordshire',
                                       '2. Mail 1975 in London'),
                           'Occupation' = c('Fernsehmoderator, Journalist, Autor',
                                            'Sängerin',
                                            'Professioneller Fußballspieler'),
                           'Family: Children' = c(3, '3 Söhn, 1 Tochter', '3 Söhne, 1 Tochter'),
                           'Name' = c('Michael Parkinson', 'Victoria Beckham', 'David Beckham'))

df <- exb_to_df(system.file("extdata", "demo_Beckhams.exb", package = "phonfieldwork"))

df_to_exb(df = df,
          name = 'Beckhams',
          output_file = 'beck.xml',
          referenced_file = 'beck.wav',
          ud_meta = meta,
          speaker_table = speaker_data)

# Remove file in order to pass checks

file.remove("beck.xml")

Dataframe to TextGrid's tier

Description

Convert a dataframe to a Praat TextGrid.

Usage

df_to_tier(df, textgrid, tier_name = "", overwrite = TRUE)

Arguments

df

an R dataframe object that contains columns named "content", "time_start" and "time_end"

textgrid

a character with a filename or path to the TextGrid

tier_name

a vector that contain a name for a created tier

overwrite

a logic argument, if TRUE overwrites the existing TextGrid file

Value

If overwrite is FALSE, then the function returns a vector of strings with a TextGrid. If overwrite is TRUE, then no output.

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

time_start <- c(0.00000000, 0.01246583, 0.24781914, 0.39552363, 0.51157715)
time_end <- c(0.01246583, 0.24781914, 0.39552363, 0.51157715, 0.65267574)
content <- c("", "T", "E", "S", "T")
df_to_tier(data.frame(id = 1:5, time_start, time_end, content),
  system.file("extdata", "test.TextGrid",
    package = "phonfieldwork"
  ),
  overwrite = FALSE
)

Draw Oscilogram, Spectrogram and annotation

Description

Create oscilogram and spectrogram plot.

Usage

draw_sound(
  file_name,
  annotation = NULL,
  from = NULL,
  to = NULL,
  zoom = NULL,
  text_size = 1,
  output_file = NULL,
  title = NULL,
  freq_scale = "kHz",
  frequency_range = c(0, 5),
  dynamic_range = 50,
  window_length = 5,
  window = "kaiser",
  windowparameter = -1,
  preemphasisf = 50,
  spectrum_info = TRUE,
  raven_annotation = NULL,
  formant_df = NULL,
  pitch = NULL,
  pitch_range = c(75, 350),
  intensity = NULL,
  output_width = 750,
  output_height = 500,
  output_units = "px",
  sounds_from_folder = NULL,
  textgrids_from_folder = NULL,
  pic_folder_name = "pics",
  title_as_filename = TRUE,
  prefix = NULL,
  suffix = NULL,
  autonumber = FALSE
)

Arguments

file_name

a sound file

annotation

a source for annotation files (path to TextGrid file or dataframe created from other linguistic types, e. g. via textgrid_to_df(), eaf_to_df() or other functions)

from

Time in seconds at which to start extraction.

to

Time in seconds at which to stop extraction.

zoom

numeric vector of zoom window time (in seconds). It will draw the whole oscilogram and part of the spectrogram.

text_size

numeric, text size (default = 1).

output_file

the name of the output file

title

the title for the plot

freq_scale

a string indicating the type of frequency scale. Supported types are: "Hz" and "kHz".

frequency_range

vector with the range of frequencies to be displayed for the spectrogram up to a maximum of fs/2. By default this is set to 0-5 kHz.

dynamic_range

values greater than this many dB below the maximum will be displayed in the same color

window_length

the desired analysis window length in milliseconds.

window

A string indicating the type of window desired. Supported types are: "rectangular", "hann", "hamming", "cosine", "bartlett", "gaussian", and "kaiser".

windowparameter

The parameter necessary to generate the window, if appropriate. At the moment, the only windows that require parameters are the Kaiser and Gaussian windows. By default, these are set to 2 for kaiser and 0.4 for gaussian windows.

preemphasisf

Preemphasis of 6 dB per octave is added to frequencies above the specified frequency. For no preemphasis, set to a frequency higher than the sampling frequency.

spectrum_info

logical. If TRUE then add information about window method and params.

raven_annotation

Raven (Center for Conservation Bioacoustics) style annotations (boxes over spectrogram). The dataframe that contains time_start, time_end, freq_low and freq_high columns. Optional columns are colors and content.

formant_df

dataframe with formants from formant_to_df() function

pitch

path to the Praat '.Pitch' file or result of pitch_to_df() function. This variable provide data for visualisation of a pitch contour exported from Praat.

pitch_range

vector with the range of frequencies to be displayed. By default this is set to 75-350 Hz.

intensity

path to the Praat '.Intensity' file or result of intensity_to_df() function. This variable provide data for visualisation of an intensity contour exported from Praat.

output_width

the width of the device

output_height

the height of the device

output_units

the units in which height and width are given. Can be "px" (pixels, the default), "in" (inches), "cm" or "mm".

sounds_from_folder

path to a folder with multiple sound files. If this argument is not NULL, then the function goes through all files and creates picture for all of them.

textgrids_from_folder

path to a folder with multiple .TextGrid files. If this argument is not NULL, then the function goes through all files and create picture for all of them.

pic_folder_name

name for a folder, where all pictures will be stored in case sounds_from_folder argument is not NULL

title_as_filename

logical. If true adds filename title to each picture

prefix

prefix for all file names for created pictures in case sounds_from_folder argument is not NULL

suffix

suffix for all file names for created pictures in case sounds_from_folder argument is not NULL

autonumber

if TRUE automatically add number of extracted sound to the file_name. Prevents from creating a duplicated files and wrong sorting.

Value

Oscilogram and spectrogram plot (and possibly TextGrid annotation).

Author(s)

George Moroz <agricolamz@gmail.com>

Examples


draw_sound(system.file("extdata", "test.wav", package = "phonfieldwork"))

draw_sound(
  system.file("extdata", "test.wav", package = "phonfieldwork"),
  system.file("extdata", "test.TextGrid",
    package = "phonfieldwork"
  )
)

draw_sound(system.file("extdata", "test.wav", package = "phonfieldwork"),
  system.file("extdata", "test.TextGrid", package = "phonfieldwork"),
  pitch = system.file("extdata", "test.Pitch",
    package = "phonfieldwork"
  ),
  pitch_range = c(50, 200)
)
draw_sound(system.file("extdata", "test.wav", package = "phonfieldwork"),
  system.file("extdata", "test.TextGrid", package = "phonfieldwork"),
  pitch = system.file("extdata", "test.Pitch",
    package = "phonfieldwork"
  ),
  pitch_range = c(50, 200),
  intensity = intensity_to_df(system.file("extdata", "test.Intensity",
    package = "phonfieldwork"
  ))
)
draw_sound(system.file("extdata", "test.wav", package = "phonfieldwork"),
  formant_df = formant_to_df(system.file("extdata", "e.Formant",
    package = "phonfieldwork"
  ))
)

Draw spectrograms

Description

This function was slightly changed from phonTools::spectrogram(). Argument description is copied from phonTools::spectrogram().

Usage

draw_spectrogram(
  sound,
  fs = 22050,
  text_size = 1,
  window_length = 5,
  dynamic_range = 50,
  window = "kaiser",
  windowparameter = -1,
  freq_scale = "kHz",
  spectrum_info = TRUE,
  timestep = -1000,
  padding = 10,
  preemphasisf = 50,
  frequency_range = c(0, 5),
  nlevels = dynamic_range,
  x_axis = TRUE,
  title = NULL,
  raven_annotation = NULL,
  formant_df = NULL
)

Arguments

sound

Either a numeric vector representing a sequence of samples taken from a sound wave or a sound object created with the loadsound() or makesound() functions.

fs

The sampling frequency in Hz. If a sound object is passed this does not need to be specified.

text_size

numeric, text size (default = 1).

window_length

The desired analysis window length in milliseconds.

dynamic_range

Values greater than this many dB below the maximum will be displayed in the same color.

window

A string indicating the type of window desired. Supported types are: rectangular, hann, hamming, cosine, bartlett, gaussian, and kaiser.

windowparameter

The parameter necessary to generate the window, if appropriate. At the moment, the only windows that require parameters are the Kaiser and Gaussian windows. By default, these are set to 2 for kaiser and 0.4 for gaussian windows.

freq_scale

a string indicating the type of frequency scale. Supported types are: "Hz" and "kHz".

spectrum_info

logical. If TRUE then add information about window method and params.

timestep

If a negative value is given, -N, then N equally-spaced time steps are calculated. If a positive number is given, this is the spacing between adjacent analyses, in milliseconds.

padding

The amount of zero padding for each window, measured in units of window length. For example, if the window is 50 points, and padding = 10, 500 zeros will be appended to each window.

preemphasisf

Preemphasis of 6 dB per octave is added to frequencies above the specified frequency. For no preemphasis, set to a frequency higher than the sampling frequency.

frequency_range

vector with the range of frequencies to be displayed for the spectrogram up to a maximum of fs/2. This is set to 0-5 kHz by default.

nlevels

The number of divisions to be used for the z-axis of the spectrogram. By default it is set equal to the dynamic range, meaning that a single color represents 1 dB on the z-axis.

x_axis

If TRUE then draw x axis.

title

Character with the title.

raven_annotation

Raven (Center for Conservation Bioacoustics) style annotations (boxes over spectrogram). The dataframe that contains time_start, time_end, freq_low and freq_high columns. Optional columns are colors and content.

formant_df

dataframe with formants from formant_to_df() function

Value

Plot the comptued spectrogram

Author(s)

Santiago Barreda <sbarreda@ucdavis.edu>

Examples


draw_spectrogram(system.file("extdata", "test.wav",
  package = "phonfieldwork"
))

ELAN's .eaf file to dataframe

Description

Convert .eaf file from ELAN to a dataframe.

Usage

eaf_to_df(file_name)

Arguments

file_name

string with a filename or path to the .eaf file

Value

a dataframe with columns: tier, id, content, tier_name, tier_type, tier_ref, event_local_id, dependent_on, time_start, time_end, source, media_url and attributes: MEDIA_URL, MIME_TYPE, RELATIVE_MEDIA_URL.

Author(s)

George Moroz <agricolamz@gmail.com>

Kudrjashov Sergej <xenomirant@gmail.com>

Examples

eaf_to_df(system.file("extdata", "test.eaf", package = "phonfieldwork"))

EXMARaLDA's .exb file to dataframe

Description

Convert .exb file from EXMARaLDA to a dataframe.

Usage

exb_to_df(file_name)

Arguments

file_name

string with a filename or path to the .exb file

Value

a dataframe with columns: tier, id, content, tier_name, tier_type, tier_category, tier_speaker, time_start, time_end, source.

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

exb_to_df(system.file("extdata", "test.exb", package = "phonfieldwork"))

Extract intervals

Description

Extract sound according to non-empty annotated intervals from TextGrid and create soundfiles with correspondent names.

Usage

extract_intervals(
  file_name,
  textgrid,
  tier = 1,
  prefix = NULL,
  suffix = NULL,
  autonumber = TRUE,
  path
)

Arguments

file_name

path to the soundfile

textgrid

path to the TextGrid

tier

tier number or name that should be used as base for extraction and names

prefix

character vector containing prefix(es) for file names

suffix

character vector containing suffix(es) for file names

autonumber

if TRUE automatically add number of extracted sound to the file_name. Prevents from creating a duplicated files and wrong sorting.

path

path to the directory where create extracted soundfiles.

Value

no output

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

# create two files in a temprary folder "test_folder"
s <- system.file("extdata", "test.wav", package = "phonfieldwork")
tdir <- tempdir()
file.copy(s, tdir)

# Extract intervals according the TextGrid into the path
extract_intervals(
  file_name = paste0(tdir, "/test.wav"),
  textgrid = system.file("extdata", "test.TextGrid",
    package = "phonfieldwork"
  ),
  path = tdir
)

list.files(tdir)
# [1] "e-2.wav" "s-3.wav" "t-1.wav" "t-4.wav" "test.wav"

FLEX's .flextext file to dataframe

Description

Convert .flextext file from FLEX to a dataframe.

Usage

flextext_to_df(file_name)

Arguments

file_name

string with a filename or path to the .flextext file

Value

a dataframe with columns: p_id, s_id, w_id, txt, cf, hn, gls, msa, morph, word, phrase, paragraph, free_trans, text, text_title

Author(s)

George Moroz <agricolamz@gmail.com>

Praat Formant object to dataframe

Description

Convert a Praat Formant object to a dataframe.

Usage

formant_to_df(file_name)

Arguments

file_name

string with a filename or path to the Formant file

Value

a dataframe with columns: time_start, time_end, frequency, bandwidth and formant

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

formant_to_df(system.file("extdata", "e.Formant", package = "phonfieldwork"))

Get file(s) duration

Description

Calculate sound(s) duration.

Usage

get_sound_duration(file_name)

Arguments

file_name

a sound file

Value

Dataframe with two columns: file name and duration

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

get_sound_duration(
  system.file("extdata", "test.wav", package = "phonfieldwork")
)

Extract TextGrid names

Description

Extract TextGrid names.

Usage

get_textgrid_names(textgrid)

Arguments

textgrid

path to the TextGrid

Value

return a vector of tier names from given TextGrid

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

get_textgrid_names(system.file("extdata", "test.TextGrid",
  package = "phonfieldwork"
))

Praat Intensity tier to dataframe

Description

Convert a Praat Intensity tier to a dataframe.

Usage

intensity_to_df(file_name)

Arguments

file_name

string with a filename or path to the Intensity tier

Value

a dataframe with columns: time_start, time_end, Intensity

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

intensity_to_df(system.file("extdata", "test.Intensity", package = "phonfieldwork"))

Praat Pitch tier to dataframe

Description

Convert a Praat Pitch tier to a dataframe.

Usage

pitch_to_df(file_name, candidates = "")

Arguments

file_name

string with a filename or path to the Pitch tier

candidates

Praat Pitch tier contains multiple candidates for each time slice, use the value "all" if you want to get them all

Value

a dataframe with columns: time_start, time_end, frequency and, if candidates = "all", candidate_id and strength

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

pitch_to_df(system.file("extdata", "test.Pitch", package = "phonfieldwork"))

Read multiple files from the folder

Description

This function reads multiple files from the folder. The first argument is the path, the second argument is the type of files to read.

Usage

read_from_folder(path, type = "textgrid")

Arguments

path

to a folder with multiple sound files.

type

should be one of the following: "duration", "audacity", "eaf", "exb", "flextext", "formant", "intensity", "picth", "srt", "textgrid"

Value

dataframe with contents of all files of a selected type

Author(s)

George Moroz <agricolamz@gmail.com>

Examples


read_from_folder(system.file("extdata", package = "phonfieldwork"), "eaf")

Remove tier from texgrid

Description

Remove tier from texgrid

Usage

remove_textgrid_tier(textgrid, tier, overwrite = TRUE)

Arguments

textgrid

character with a filename or path to the TextGrid

tier

value that could be either ordinal number of the tier either name of the tier

overwrite

logical. If TRUE (by dafault) it overwrites an existing tier.

Value

a string that contain TextGrid. If argument write is TRUE, then no output.

Rename soundfiles

Description

Rename soundfiles using the template from user.

Usage

rename_soundfiles(
  stimuli,
  translations = NULL,
  prefix = NULL,
  suffix = NULL,
  order = NULL,
  missing = NULL,
  path,
  autonumbering = TRUE,
  backup = TRUE,
  logging = TRUE
)

Arguments

stimuli

character vector of stimuli

translations

character vector of translations (optonal). This values are added after stimuli to the new files' names so the result will be ...stimulus_translation....

prefix

character vector of length one containing prefix for file names

suffix

character vector of length one containing suffix for file names

order

numeric vector that define the order of stimuli. By default the order of the stimuli is taken.

missing

numeric vector that define missing stimuli in case when some stimuli are not recorded.

path

path to the directory with soundfiles.

autonumbering

logical. If TRUE, function creates an automatic numbering of files.

backup

logical. If TRUE, function creates backup folder with all files. By default is TRUE.

logging

logical. If TRUE creates a .csv file with the correspondences of old names and new names. This could be useful for restoring in case something goes wrong.

Value

no output

Author(s)

George Moroz <agricolamz@gmail.com>

Rewrite TextGrid names

Description

Rewrite TextGrid names.

Usage

set_textgrid_names(textgrid, tiers, names, write = TRUE)

Arguments

textgrid

path to the TextGrid

tiers

integer vector with the number of tiers that should be named

names

vector of strings with new names for TextGrid tiers

write

logical. If TRUE (by dafault) it overwrites an existing tier

Value

a string that contain TextGrid. If argument write is TRUE, then no output.

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

set_textgrid_names(system.file("extdata", "test.TextGrid",
  package = "phonfieldwork"
),
tiers = 3, names = "new_name", write = FALSE
)

Subtitles .srt file to dataframe

Description

Convert subtitles .srt file to a dataframe.

Usage

srt_to_df(file_name)

Arguments

file_name

string with a filename or path to the .srt file

Value

a dataframe with columns: id, content, time_start, time_end, source.

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

srt_to_df(system.file("extdata", "test.srt", package = "phonfieldwork"))

TextGrid to dataframe

Description

Convert Praat TextGrid to a dataframe.

Usage

textgrid_to_df(file_name)

Arguments

file_name

string with a filename or path to the TextGrid

Value

a dataframe with columns: id, time_start, time_end (if it is an interval tier – the same as the start value), content, tier, tier_name and source

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

textgrid_to_df(system.file("extdata", "test.TextGrid",
  package = "phonfieldwork"
))

# this is and example of reading a short .TextGrid format
textgrid_to_df(system.file("extdata", "test_short.TextGrid",
  package = "phonfieldwork"
))

TextGrid's tier to dataframe

Description

Convert selected tier from a Praat TextGrid to a dataframe.

Usage

tier_to_df(file_name, tier = 1)

Arguments

file_name

string with a filename or path to the TextGrid

tier

value that could be either ordinal number of the tier either name of the tier. By default is '1'.

Value

a dataframe with columns: id, time_start, time_end, content, , tier_name

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

tier_to_df(system.file("extdata", "test.TextGrid",
  package = "phonfieldwork"
))
tier_to_df(
  system.file("extdata", "test.TextGrid",
    package = "phonfieldwork"
  ),
  "intervals"
)