Skip to contents

Get the chapter label for a chapter

Usage

bm_get_chapter_label(
  x,
  chapterId,
  dataId = "metadata",
  dataKey = "chapter_label"
)

Arguments

x

An object with class "bm_prepared_book", containing the bookmarked data and each chapter's contents, as with the dependency trees of each chapter in the book stored in a names list as attribute dependencyTrees (each list element is a dependency tree, and the tree's name is the identifier of the corresponding chapter).

chapterId

The identifier for the chapter(s) for which you want the label (i.e the 'Human-readable name').

dataId, dataKey

The identifier and key holding the chapter label.

Value

The chapter's label as a character vector.