corpus-class {act}R Documentation

Corpus object

Description

This is the main object the act package uses. It collects the annotations and meta data from loaded annotation files.

Details

Some of the slots are defined by the user. Some slots report results, such as @import.results and @history and . Other slots are settings and are used when performing functions on the corpus oibject. To change the normalization matrix use x@normalization.matrix <- act::matrix_load(path="...")

Slots

name

Character string; Name of the corpus.

transcripts

List of transcript objects; Each annotation file that has been load is stored in this list as a transcript object.

paths.annotation.files

Vector of character strings; Path(s) to one or several folders where your annotation files are located.

paths.media.files

Vector of character strings; Path(s) to one or several folders where your media files are located.

normalization.matrix

Data.frame; Replacement matrix used for normalizing the annotations.

import.skip.double.files

Logical; if TRUE files with the same names will be skipped (only one of them will be loaded), if FALSE transcripts will be renamed to make the names unique.

import.names.include

Vector of character strings; Only files matching this regular expression will be imported into the corpus.

import.names.exclude

Vector of character strings; Files matching this regular expression will be skipped and not imported into the corpus.

import.names.modify

List; Options how to modify the names of the transcript objects when they are added to the corpus. These options are useful, for instacne, if your annotation files contain character sequences that you do not want to include into the transcript name in the corpus (e.g. if you regularly add a date to the file name of your annotations files as 'myFile_2020-09-21.TextGrid').

import.results

Data.frame; information about the import of the annotation files.

history

List; History of modifications made by any of the package functions to the corpus.

Examples

library(act)

examplecorpus


[Package act version 1.3.1 Index]