options_show: Options of the package

In act: Aligned Corpus Toolkit

Options of the package

Description

The package has numerous options that change the internal workings of the package.

Usage

options_show()

Details

There are several options that change the way the package works. They are set globally.

• Use options(name.of.option = value) to set an option.

• Use options()$name.of.option to get the current value of an option.

• Use act::options_reset to set all options to the default value.

• Use act::options_delete to clean up and delete all option settings.

The package uses the following options.

Program

• act.excamplecorpusURL character strings; where to download example media files.

• act.updateX Logical; If TRUE the original corpus object 'x' passed passed to the search functions search_new and search_run will also be updated, in case that during the search fulltexts are created or the normalization is performed.

• act.showprogress logical; if TRUE a progress bar will be shown during (possibly) time consuming operations.

Paths

• act.path.praat Character string; path to the 'Praat' executable on your computer. Only necessary if you use the functions to remote control Praat using Praat scripts.

• act.path.sendpraat Character string; path to the 'sendpraat' executable on your computer. Only necessary if you use the functions to remote control Praat using Praat scripts.

• act.path.elan Character string; path to the 'ELAN' executable on your computer. Only necessary if you want to open search results in ELAN.

File formats

• act.fileformats.video Vector of character strings; Suffixes of video files that will be identified; default is 'c("mp4", "mov")'.

• act.fileformats.audio Vector of character strings; Suffixes of audio files that will be identified; default is 'c("wav", "aif", "mp3")'.

FFMPEG commands and options

• act.ffmpeg.command Character string; 'FFmpeg' command that is used for cutting video files.

• act.ffmpeg.command.fastVideoPostioning Character string; 'FFmpeg' command that is used for cutting video files using the 'FFmpeg' option 'fast video positioning'. This is considerably faster when working with long video files.

• act.ffmpeg.command.audio Character string; 'FFmpeg' command that is used for cutting/generating uncompressed audio files.

• act.ffmpeg.exportchannels.fromColumnName Character string; Name of the column in the data frame s@results from information, which audio channel to export, will be taken.

Import annotation files

• act.import.readEmptyIntervals Logical; if TRUE empty intervals in you annotation files will be read, if FALSE empty intervals will be skipped.

• act.import.scanSubfolders Logical; if TRUE sub folders will also be scanned for annotation files; if FALSE only the main level of the folders specified in paths.annotation.files of your corpus object will be scanned.

• act.import.storeFileContentInTranscript if TRUE the contents of the original annotation file will be stored in [e-mail]. Set to FALSE if you want to keep your corpus object small.

Export

• act.export.foldergrouping1.fromColumnName Character string; Name of sub folders that will be created in the folder of the search result, level 1.

• act.export.foldergrouping2.fromColumnName Character string; Name of sub folders that will be created in the folder of the search result, level 2.

• act.export.filename.fromColumnName Character string; Name of the column from which the file names for exported files will be taken.

Miscellaneous

• act.separator_between_intervals Character; Single character that is used for separating intervals when creating the full text.

• act.separator_between_tiers Character; Single character that is used for separating tiers when creating the full text.

• act.separator_between_words Character string; regular expression with alternatives that count as separators between words. Used for preparing the concordance.

• act.wordCountRegEx Character string; regular expression that is used to count words.

Value

Nothing.

Examples

library(act)
## Not run: 
act::options_show()

## End(Not run)

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