Create Breath Object

Source: R/1-construct-breath.R

Create a Breath object to represent a breath mark.

Breath(i, to = NULL, symbol = NULL)

Arguments

i

A single positive integer, which represents the position of the breath mark in a musical line.

to

Optional. A single character or a single positive integer, which indicates the musical line where to add the breath mark.

symbol

Optional. A single character which can be "comma", "tick", "upbow", and "salzedo". It represents the symbol used for the breath mark. The default symbol is "comma". See the MusicXML specification.

Value

A list of class Breath.

See also

+.Music() for adding a breath mark to a Music object.

Examples

# Create a breath mark
breath <- Breath(1)
breath
#> Breath Mark 
#> 
#> * to be added at position 1 

# Add it to a `Music`
music <- Music() + Meter(4, 4) + Line(c("C4", "D4")) + breath
music
#> Music 
#> 
#> $meters
#> # A tibble: 1 × 6
#>     bar number  unit actual_number actual_unit invisible
#>   <int>  <int> <int>         <int>       <int> <lgl>    
#> 1     1      4     4             4           4 FALSE    
#> 
#> $notes
#> # A tibble: 2 × 7
#>    line     i     j pitch  midi duration length
#>   <int> <int> <int> <chr> <int> <chr>     <dbl>
#> 1     1     1    NA C4       60 NA            1
#> 2     1     2    NA D4       62 NA            1
#> 
#> $lines
#> # A tibble: 1 × 7
#>    part staff voice segment   bar offset name 
#>   <int> <int> <int>   <int> <int>  <dbl> <chr>
#> 1     1     1     1       1     1      0 NA   
#> 
#> $breaths
#> # A tibble: 1 × 3
#>    line     i symbol
#>   <int> <int> <chr> 
#> 1     1     1 NA    
#> 

# Generate the music score
if (interactive()) {
  show(music)
}