Learn R Programming

emuR - Main package of the EMU Speech Database Management System

Out of funding

Unfortunately, the EMU-SDMS is currently out of funding.

We at the IPS will do what we can to fix bugs, security issues or necessary adjustments to new versions of R; but we cannot currently work on new features or performance improvements.

We would be very glad if funding in academia allowed for more technical staff to maintain software used by the research community.

Introduction

The emuR package provides the next iteration of the EMU Speech Database Management System (EMU-SDMS) with database management, data extraction, data preparation and data visualization facilities. It also contains a server that is intended to host databases in the emuDB format (see vignette('emuDB_intro')) to the EMU-webApp (http://ips-lmu.github.io/EMU-webApp/). The querying of annotations is performed using EMU's own EQL2 (EMU Query Language Version 2).

This package is part of the next iteration of the EMU Speech Database Management System which aims to be as close to an all-in-one solution for generating, manipulating, querying, analyzing and managing speech databases as possible. For an overview of the system please see http://ips-lmu.github.io/EMU.html and/or https://www.sciencedirect.com/science/article/pii/S0885230816302601 .

Installation

install.packages("emuR")

As this also installs all of the dependencies (incl. the wrassp package) this is the only installation step necessary to install the EMU-SDMS on your system. The only other requirement of the EMU-SDMS is a modern web browser (Chrome (recommended!) / Firefox / ...) which most people should already have on their systems.

Quick start

For more information see the The EMU-SDMS Manual

For Developers / Beta-Testers

Installation (two alternative methods)

  • either download & extract the package from GitHub. Then install it with the following command:
install.packages("path/to/emuR", repos = NULL, type="source")
  • or install the latest development version from GitHub (preferred method):
library(devtools)
install_github("IPS-LMU/emuR", build_vignettes = TRUE)

Copy Link

Version

Install

install.packages('emuR')

Monthly Downloads

497

Version

2.5.0

License

GPL (>= 2)

Issues

Pull Requests

Stars

Forks

Maintainer

Last Published

March 15th, 2024

Functions in emuR (2.5.0)

AddListRemoveSsffTrackDefinition

Add / List / Remove ssffTrackDefinition to / from / of emuDB
SetGetSignalCanvasesOrder

Set / Get signalCanvasesOrder of / to / from emuDB
AddListRemoveLinkDefinition

Add / List / Remove linkDefinition to / of / from emuDB
AddListRenameRemoveAttributeDefinitions

Add / List / Rename / Remove attribute definition to / of / from emuDB
AddListRemoveLevelDefinitions

Add / List / Remove level definition to / of / from emuDB
AddListRemovePerspective

Add / List / Remove perspective to / of / from emuDB
AddListRemoveLabelGroup

Add / List / Remove global labelGroup to / of / from emuDB
SetGetRemoveLegalLabels

Set / Get / Remove legal labels of attributeDefinition of emuDB
SetGetlevelCanvasesOrder

Set / Get level canvases order of emuDB
AddListRemoveAttrDefLabelGroup

Add / List / Remove labelGroup to / of / from attributeDefinition of emuDB
as.spectral

Function to convert an object into an object of class 'spectral'.
bark

Convert Hertz to Bark and Bark to Hertz
bayesian.metric

bayesian metric
Slope.test

Slope Test
as.trackdata

Create an Emu trackdata object
autobuild_linkFromTimes

Autobuild links between two levels using their time information
add_files

Add files to emuDB
bayes.lab

bayes lab
bayes.dist

bayes dist
bridge

Three-columned matrix
as.matrix.emusegs

as.matrix.emusegs
bayesplot

bayesplot
classplot

Produce a classification plot from discriminant or SVM modelling
convert_TextGridCollection

Convert a TextGridCollection (e.g. .wav & .TextGrid files) to emuDB
by.trackdata

A method of the generic function by for objects of class 'trackdata'
cen.sub

Subfunction of cen
cbind.trackdata

A method of the generic function cbind for objects of class 'trackdata'
convert_BPFCollection

Convert a Bas Partitur File Collection (audio and BAS Partitur files) to an emuDB
create_emuRtrackdata

create emuRtrackdata object
create_emuRdemoData

Create demo data for the emuR package
bind

class method bind data
closest

closest
convert_legacyEmuDB

Convert legacy EMU database to the emuDB format
convert_txtCollection

Converts a collection of audio files and plain text transcriptions into an emuDB
coutts.rms

rms Data to coutts segment list
bind.default

data binding
classify

classify
buildtrack

Build trackdata objects from the output of by()
create_itemsInLevel

Create new items programmatically
create_links

create links between items
coutts.sam

Trackdata of acoustic waveforms from the segment list coutts
dapply

apply a function to each part of a trackdata object
convert_wideToLong

convert tracks of a tibble trackdata object to the long form
dct

Discrete Cosine Transformation
dbtopower

Function for inter-converting between decibels and a linear scale
coutts2.l

Vector of word label from the segment list coutts2
dbnorm

Function to dB-normalise spectral objects
dextract

Extract a subset of data from a trackdata object
dcut

Function to extract a vector or matrix from EMU-Trackdata at a single time point of to create another EMU-trackdata object between two times.
ddiff

Differentiation of tracks
dim.trackdata

A method of the generic function dim for objects of class 'trackdata'
delete_itemsInLevel

Delete items programmatically
dip.fdat

Trackdata of formants from the segment list dip
coutts2.sam

Trackdata of acoustic waveforms from the segment list coutts2
demo.all

Emu segment list
coutts

Segment list of words, read speech, female speaker of Australian English from database epgcoutts
bind.trackdata

bind trackdata
dextract.lab

Extract a subset of data from a trackdata object
dip

Segment list of diphthongs, two speakers one male, one female , Standard North German, read speech from database kielread
distance

distance
emuRtrackdata

emuR track data object
demo.all.rms

Emu track data for a rms track for segment list demo.all
emusegs.database

emusegs database
emusegs.query

emusegs query
dplot

A function to plot one or more columns of EMU-trackdata as a function of time (DEPRECATED see below)
emusegs.type

segment list type
ellipse

Calculate ellipse coordinates
dimnames.trackdata

Dimnames of trackdata object
create_emuDB

Create empty emuDB
cr

Plot digital sinuoids.
e.dft

Spectral vector of a single E vowel produced by a male speaker of Standard North German.
euclidean

Find the inter-euclidean distance for a data matrix
export_BPFCollection

Exports an emuDB into a BAS Partitur File (BPF) Collection
coutts2.epg

EPG-compressed trackdata from the segment list coutts2
coutts.epg

EPG-compressed trackdata from the segment list coutts
coutts.l

Vector of word label from the segment list coutts
coutts2

Segment list, same as coutts but at a slower speech rate
expand_labels

Label each data sample
emuRsegs

emuR segment list
emuR-package

emuR - Main Package of the EMU Speech Database Management System
create_spectrogram_image_as_raster

Create spectrogram image as raster
dur.emusegs

Duration of segments (NOTE: does not work for new default resultType = "tibble" of query())
demo.vowels.f0

F0 track data for segment list demo.vowels
demo.vowels

Emu segment List
crplot

Function to plot a digital sinusoid and the circle from which it is derived.
get.time.element

Get data for a given time
demo.vowels.fm

Formant track data for segment list demo.vowels
demo.all.fm

Formant track data for segment list demo.vowels
fric.w

Vector of word labels from the segment list fric.
label_num

num label
dsmooth

Smooth the data in a trackdata object.
epggs

Plot a grey-scale image of palatographic data.
epgsum

Sum contacts in palatograms.
get.trackkeywrd

get trackkeywrd
gerst.sub

gerst sub
epgplot

Plot palatographic data
dip.l

Vector of phoneme labels from the segment list dip
dtime

time signal times
dip.spkr

Vector of speaker labels from the segment list dip
demo.all.f0

F0 track data for segment list demo.vowels
eplot

Plot ellipses for two-dimensional data (DEPRECATED see below)
linear

Perform linear time normalisation on trackdata.
epgai

Electropalatographic contact indices
isol.fdat

Trackdata of formants from the segment list isol
isol.l

Vector of vowel phoneme labels from the segment list isol
duplicate_level

Duplicate level
dur

duration
export_seglistToTxtCollection

Exports a segment list to txt collection
epgcog

Electropalatographic centre of gravity
engassim.epg

EPG-compressed trackdata from the segment list engassim
dur.trackdata

Duration of trackdata elements
engassim

Segment list of a sequence of syllable final n or N preceding k or g , isolated words single speaker, Australian English female from database epgassim.
lob.sub

lob sub
engassim.l

Vector of phonetic labels from the segment list engassim: nK = nk,ng , sK = sk,sg
is.trackdata

Test whether an object is an Emu trackdata object
frames

frames
fapply

Function that applies a function to an EMU spectral object
engassim.w

Vector of word labels from the segment list engassim.
list_sessions

List sessions of emuDB
export_TextGridCollection

Export annotations of emuDB to TextGrid collection
freqtoint

Function to find the column number corresponding to frequencies of a spectral object
frames.time

Find the time and position of a data element.
print.emuRsegs

Print emuRsegs segment list
polygonplot

polygonplot
norm

Normalise speech data
nearey.sub

nearey sub
load_emuDB

Load emuDB
fric.dft

Spectral trackdata object from the segment list fric.
label_convert

convert label
label

Get labels / utterances from segment list
fric.l

Vector of labels from the segment list fric
get_trackdata

Get trackdata from loaded emuDB
rename_bundles

Rename bundles in emuDB
isol

Segment list of vowels in a d d context isolated word speech, one male speaker of Australian English from database isolated.
import_mediaFiles

Import media files to emuDB
rename_emuDB

Rename emuDB
matscan

Read matrix data from a file
list_bundles

List bundles of emuDB
fric

Segment list of word-medial s or z one male speaker of Standard North German, read speech from database kielread.
linear.av

linear av
mahalanobis.metric

mahalanobis metric
is.seglist

is seglist
mel

Convert Hz to the mel scale
mu.linetype.get

mu linetype get
make.emuRsegs

Make emuDB segment list
moments

Function to calculate statistical moments
mu.colour.get

get a EMU color
locus

Calculate locus equations for two-dimensional data
mu.colour

Function for specifying color, linetype, and line-widths in EMU plotting functions.
muclass

Find common elements in vectors
mu.legend

make a EMU legend
list_files

List files of emuDB
resample_annots

Resample annotations (_annot.json) files of emuDB
list_sampleRates

List sample rates of media and annotation (_annot.json) files
mahal

Classify using Mahalanobis distance
polhom.epg

EPG-compressed trackdata from the segment list polhom
polhom.l

Vector of phonetic labels from the segment list polhom
polhom

Segment list of four Polish homorganic fricatives from database epgpolish.
plot.trackdata

Produces time-series plots from trackdata
sort.emuRsegs

Sort emuRsegs segment list by session, bundle and sample_start
requery_seq

Requery sequential context of segment list in an emuDB
[.EPG

expand EPG
sortmatrix

Sort matrix by label
make.seglist

Make an Emu segment list from the various components
is.spectral

Function to test whether the object is of class "spectral"
rescale.gerst

rescale gerst
perform

Performance (hit rate) of a confusion matrix
mahal.dist

Calculate mahalanobis distances
palate

Obtain a three-dimensional palatographic array
makelab

Write out ESPS-style label files
read_bundleList

read bundleList
read.emusegs

Create an Emu segment list from a file
normalize_length

Normalize length of segments contained in a data.frame like object returned by get_trackdata
rescale.lob

rescale lob
mel.default

mel default
modify.seglist

Modify one of the components of an Emu segment list
rbind.trackdata

A method of the generic function rbind for objects of class trackdata
randomise.segs

Randomise or Reverse items in a segment list
[.spectral

Expand spectral
tracktimes

Get the track times from EMU trackdata objects
replace_itemLabels

Replace item labels
print.emuRtrackdata

Print emuRtrackdata object
serve

Serve EMU database to EMU-webApp
requery_hier

Requery hierarchical context of a segment list in an emuDB
plafit

Calculate the coefficients of a parabola
outliers

outliers
runBASwebservice_minni

Creates a rough phonetic segmentation by running the phoneme decoder webservice MINNI.
vowlax.rms.5

Vector of RMS energy values at the temporal midpoint extracted at the temporal midpoint from the segment list vowlax
vowlax.rms

Trackdata of RMS energy from the segment list vowlax
shift

Function to shift the elements of a vector.
runBASwebservice_pho2sylCanonical

Adds syllabified word labels to a word level that already contains canonical pronunciations.
write_bundleList

write bundleList
train

Train a Gaussian Model
print.emusegs

print emusegs
plot.spectral

Plot spectra from EMU spectral objects
splitstring

Split a string into words.
print.trackdata

print trackdata
summary.emuDBhandle

Print summary of loaded EMU database (emuDB).
[.trackdata

Expand trackdata
start.emusegs

Start and end times for EMU segment lists and trackdata objects
update_itemsInLevel

Update items programmatically
vowlax.spkr

Vector of speaker labels from the segment list vowlax.
trapply

A method of the generic function by for objects of class 'trackdata'
query

Query emuDB
runBASwebservice_all

Runs several BAS webservices, starting from an orthographic transcription
rad

Function to convert between Hertz and Radians
rescale.nearey

rescale nearey
vowlax.word

Vector of word labels from the segment list vowlax.
runBASwebservice_chunker

Creates a chunk segmentation using the webservice Chunker.
radians

Converts degrees to radians
trackdata

Track data object
runBASwebservice_g2pForTokenization

Tokenizes an orthographic transcription.
runBASwebservice_maus

Runs MAUS webservice to create a phonetic segmentation
summary.emusegs

summary emusegs
trackfreq

function to find the frequencies of a spectral object
vowlax.fund

Trackdata of fundamental frequency from the segment list vowlax
summary.trackdata

summary trackdata
vowlax.dft.5

Spectral matrix centred at the temporal midpoint of the vowels from the segment list vowlax.
runBASwebservice_pho2sylSegmental

Creates a syllable segmentation on the basis of a phonetic segmentation.
runBASwebservice_g2pForPronunciation

Creates canonical pronunciation attributes for a tier of tokenized orthographical words.
vowlax.l

Vector of phoneme labels from the segment list vowlax
wordlax.l

Vector of word labels from segment list wordlax
write.emusegs

Write an Emu segment list to a file
vowlax.fdat.5

Matrix of formant data extracted at the temporal midpoint from the segment list vowlax.
segmentlist

Segment list
vowlax.fdat

Trackdata of formants from the segment list vowlax
vowlax.fund.5

Vector of fundamental frequency extracted at the temporal midpoint from the segment list vowlax.
vowlax

Segment list of four lax vowels, read speech, one male and one female speaker of Standard North German from database kielread.
track.gradinfo

Calculate gradient summary information for trackdata
track.gradinfo.sub

track gradinfo sub
vowlax.df

Data frame of various parameters and labels from the segment list vowlax
vowlax.left

Vector of labels preceding the vowels from the segment list vowlax
vowlax.right

Vector of labels following the vowels from the segment list vowlax