readelan

The goal of {readelan} is to access the data (i.e., annotations) and metadata (e.g., tier types/structure, linked media and controlled vocabularies) in ELAN annotation files (.eaf), template files (.etf) and external controlled vocabulary files (.ecv) directly in R.

Installation

You can download the official release version of {readelan} from CRAN:

install.packages("readelan")

Alternatively, you can install the development version like so:

pak::pak("borstell/readelan")

Basic use

The purpose of the {readelan} package is to allow users to read data and metadata from ELAN files.

By loading the package into your session, you get access the the package’s function:

library(readelan)

Annotations

To read annotations from an .eaf file, you can use the read_eaf() function.

Tiers

To retrieve the tiers (IDs/names, types, parent-child structure, etc.) of either an .eaf (annotation) or an .etf (template) file, you can use the read_tiers() function.

Media metadata

To find the media metadata (file paths and types of linked audio and video files) of an .eaf file, you can use the read_media() function.

Controlled vocabularies (CV)

To extract either internal controlled vocabularies (CV) or linked external controlled vocabularies (ECV) of an .eaf (annotation), .etf (template) or .ecv (external CV) file, you can use the read_cv() function.

Multiple files

All read_ functions in {readelan} accept either a single file or a vector of files as input.

License & Citation

License

{readelan} is released under the permissive MIT License.

Citation

You can cite {readelan} by using the citation("readelan") function in R (see also Citation)