gloss_example: Gloss an example

View source: R/gloss_example.R

gloss_exampleR Documentation

Gloss an example

Description

Creates an interlinear glossed example for linguistics.

Usage

gloss_example(
  transliteration,
  glosses,
  free_translation = "",
  comment = "",
  annotation = NULL,
  grammaticality = NULL,
  audio_path = NULL,
  audio_label = "♪",
  video_path = NULL,
  video_width = 320,
  video_height = 240,
  line_length = 70,
  italic_transliteration = getOption("lingglosses.italic_transliteration"),
  drop_transliteration = FALSE,
  intext = FALSE,
  write_to_db = TRUE
)

Arguments

transliteration

character vector of the length one for the transliteration line.

glosses

character vector of the length one for the glosses line.

free_translation

character vector of the length one for the free translation line.

comment

character vector of the length one for the comment line (under the free translation line).

annotation

character vector of the length one for the annotation line (above translation).

grammaticality

character vector with the grammaticality value.

audio_path

character string with the path to the sound in .wav format.

audio_label

character string for the label to display.

video_path

character string with the path to the video.

video_width

width argument for the video in px.

video_height

height argument for the video in px.

line_length

integer vector of the length one that denotes maximum number of characters per one line.

italic_transliteration

logical variable that denotes, whether user wants to italicize your example.

drop_transliteration

logical variable that denotes, whether user wants to have an example without transliteration.

intext

logical variable that denotes, whether example should be considered as part of the text (TRUE) or as a standalone paragraph (FALSE)

write_to_db

logical variable that denotes, whether example should be added to the example database.

Value

html/latex output(s) with glossed examples.

Author(s)

George Moroz <agricolamz@gmail.com>

Examples

gloss_example("bur-e-**ri** c'in-ne-s:u",
              "fly-NPST-**INF** know-HAB-NEG",
              "I cannot fly. (Zilo Andi, East Caucasian)",
              grammaticality = "*",
              comment = "(lit. do not know how to)")

gloss_example("bur-e-**ri** c'in-ne-s:u",
              "fly-NPST-**INF** know-HAB-NEG",
              "I cannot fly.",
              intext = TRUE)


agricolamz/lingglosses documentation built on Oct. 12, 2023, 3:18 p.m.