export_eaf: Export a transcript object to a 'ELAN' .eaf file

In act: Aligned Corpus Toolkit

Export a transcript object to a 'ELAN' .eaf file

Description

Advice: In most situations it is more convenient to use act::corpus_export for exporting annotation files.

Usage

export_eaf(
  t,
  outputPath = NULL,
  filterTierNames = NULL,
  filterSectionStartsec = NULL,
  filterSectionEndsec = NULL,
  createMediaLinks = TRUE
)

Arguments

t	Transcript object; transcript to be exported.
outputPath	Character string; path where .eaf file will be saved.
filterTierNames	Vector of character strings; names of tiers to be included. If left unspecified, all tiers will be exported.
filterSectionStartsec	Double; start of selection in seconds.
filterSectionEndsec	Double; end of selection in seconds.
createMediaLinks	Logical; if TRUE media links will be created.

Details

The .eaf file will be written to the file specified in outputPath. If outputPath is left empty, the function will return the contents of the .eaf itself.

Value

Contents of the .eaf file (only if outputPath is left empty)

See Also

corpus_export, export_exb, export_printtranscript, export_rpraat, export_srt, export_textgrid

Examples

library(act)

# Get the transcript you want to export
t <- examplecorpus@transcripts[[1]]

# Create temporary file path
path <- tempfile(pattern = t@name, tmpdir = tempdir(), fileext = ".eaf")

# It makes more sense, however, to you define a destination folder
# that is easier to access on your computer
## Not run: 
path <- file.path("PATH_TO_AN_EXISTING_FOLDER_ON_YOUR_COMPUTER",
                   paste(t@name, ".eaf", sep=""))

## End(Not run)

# Export WITH media links
act::export_eaf(t=t, outputPath=path)

# Export WITHOUT media links
act::export_eaf(t=t, outputPath=path, createMediaLinks = FALSE)

act documentation built on June 7, 2023, 6:16 p.m.