note-checks {tabr}

Basic noteworthy string checks

Description

The simplest functions for inspecting noteworthy strings to see if their notes have certain properties.

Usage

note_is_accidental(notes)

note_is_natural(notes)

note_is_flat(notes)

note_is_sharp(notes)

note_has_accidental(notes)

note_has_natural(notes)

note_has_flat(notes)

note_has_sharp(notes)

Arguments

notes

character, a noteworthy string.

Details

Note that these functions are the weakest in terms of checking noteworthiness. They are simple regular expression-based wrappers. They are often used internally by more complex functions without wasting computational overhead on performing input validity checks, but they are exported from the package for user convenience. Their results will only make sense on strings that you define in accordance with noteworthy string rules.

The ⁠note_is_*⁠ functions return a logical vector with length equal to the number of timesteps in notes. The ⁠note_has_*⁠ functions summarize these to a single logical value.

Value

logical

See Also

note-metadata(), note-summaries(), note-coerce(), valid-notes()

Examples

x <- "r a_2 a a#' s"
note_has_accidental(x)
note_has_natural(x)
note_has_flat(x)
note_has_sharp(x)
note_is_accidental(x)
note_is_natural(x)
note_is_flat(x)
note_is_sharp(x)
note_has_tick(x)
note_has_integer(x)
note_is_tick(x)
note_is_integer(x)
note_has_rest(x)
note_is_rest(x)