diff --git a/DESCRIPTION b/DESCRIPTION index 2d20685..32d3e66 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: tabr Title: Music Notation Syntax, Manipulation, Analysis and Transcription in R -Version: 0.5.0 -Authors@R: person("Matthew", "Leonawicz", email = "mfleonawicz@gmail.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-9452-2771")) +Version: 0.5.1 +Authors@R: person("Matthew", "Leonawicz", email = "rpkgs@pm.me", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-9452-2771")) Description: Provides a music notation syntax and a collection of music programming functions for generating, manipulating, organizing, and analyzing musical information in R. Music syntax can be entered directly in character @@ -49,5 +49,5 @@ ByteCompile: true Encoding: UTF-8 LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.2 SystemRequirements: LilyPond v2.22.1-2+ (needed for rendering sheet music or writing MIDI files) diff --git a/NEWS.md b/NEWS.md index 1d2387b..44663a9 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# tabr 0.5.1 + +* Minor updates. + # tabr 0.5.0 * Refactored and made improvements to `plot_fretboard()` and `plot_chord()` including the addition of `fret_labels` and `fret_offset` arguments. diff --git a/R/tabr.R b/R/tabr.R index 25fb4cd..f7f59bd 100644 --- a/R/tabr.R +++ b/R/tabr.R @@ -1,6 +1,9 @@ globalVariables(c(".data", ":=")) -#' tabr: Music notation syntax, manipulation, analysis and transcription in R. +#' @name tabr +"_PACKAGE" + +#' tabr: Additional Detals #' #' The `tabr` package provides a music notation syntax and a collection of music #' programming functions for generating, manipulating, organizing and analyzing @@ -46,9 +49,7 @@ globalVariables(c(".data", ":=")) #' use the package for music analysis without installing LilyPond if you do not #' intend to render tabs. #' -#' @docType package -#' @name tabr -#' @aliases tabr-package +#' @name tabr-details NULL #' @importFrom tibble tibble diff --git a/README.Rmd b/README.Rmd index 07665a9..c366b26 100644 --- a/README.Rmd +++ b/README.Rmd @@ -22,9 +22,9 @@ as_music("d2.;5 c8 d~ d a, c d g-;4 a- g f~ f2- d'8;3 f'4;2 c''8;1 a'2 a4;3 f;4" [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/) [![R-CMD-check](https://github.com/leonawicz/tabr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/leonawicz/tabr/actions/workflows/R-CMD-check.yaml) -[![Codecov test coverage](https://codecov.io/gh/leonawicz/tabr/branch/master/graph/badge.svg)](https://app.codecov.io/gh/leonawicz/tabr?branch=master) -[![CRAN status](http://www.r-pkg.org/badges/version/tabr)](https://cran.r-project.org/package=tabr) -[![CRAN downloads](http://cranlogs.r-pkg.org/badges/grand-total/tabr)](https://cran.r-project.org/package=tabr) +[![Codecov test coverage](https://codecov.io/gh/leonawicz/tabr/graph/badge.svg)](https://app.codecov.io/gh/leonawicz/tabr) +[![CRAN status](https://www.r-pkg.org/badges/version/tabr)](https://CRAN.R-project.org/package=tabr) +[![CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/tabr)](https://cran.r-project.org/package=tabr) [![Github Stars](https://img.shields.io/github/stars/leonawicz/tabr.svg?style=social&label=Github)](https://github.com/leonawicz/tabr) @@ -36,7 +36,7 @@ The music notation framework facilitates creating and analyzing music data in no ## Citation -Matthew Leonawicz (`r substr(Sys.Date(), 1, 4)`). tabr: Music Notation Syntax, Manipulation, Analysis and Transcription in R. R package version 0.5.0. https://CRAN.R-project.org/package=tabr +Matthew Leonawicz (`r substr(Sys.Date(), 1, 4)`). tabr: Music Notation Syntax, Manipulation, Analysis and Transcription in R. R package version 0.5.1. https://CRAN.R-project.org/package=tabr ## Contribute diff --git a/README.md b/README.md index 6c08fd0..3f11f6a 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,11 @@ state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/) [![R-CMD-check](https://github.com/leonawicz/tabr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/leonawicz/tabr/actions/workflows/R-CMD-check.yaml) [![Codecov test -coverage](https://codecov.io/gh/leonawicz/tabr/branch/master/graph/badge.svg)](https://app.codecov.io/gh/leonawicz/tabr?branch=master) +coverage](https://codecov.io/gh/leonawicz/tabr/graph/badge.svg)](https://app.codecov.io/gh/leonawicz/tabr) [![CRAN -status](http://www.r-pkg.org/badges/version/tabr)](https://cran.r-project.org/package=tabr) +status](https://www.r-pkg.org/badges/version/tabr)](https://CRAN.R-project.org/package=tabr) [![CRAN -downloads](http://cranlogs.r-pkg.org/badges/grand-total/tabr)](https://cran.r-project.org/package=tabr) +downloads](https://cranlogs.r-pkg.org/badges/grand-total/tabr)](https://cran.r-project.org/package=tabr) [![Github Stars](https://img.shields.io/github/stars/leonawicz/tabr.svg?style=social&label=Github)](https://github.com/leonawicz/tabr) @@ -34,7 +34,7 @@ language of a musician than, say, an audio engineer. ## Citation Matthew Leonawicz (2024). tabr: Music Notation Syntax, Manipulation, -Analysis and Transcription in R. R package version 0.5.0. +Analysis and Transcription in R. R package version 0.5.1. ## Contribute diff --git a/docs/404.html b/docs/404.html index b50ff14..542a634 100644 --- a/docs/404.html +++ b/docs/404.html @@ -26,7 +26,7 @@ - +
@@ -49,14 +49,14 @@
  • - + Home
    • - +
    @@ -191,16 +191,16 @@

    Page not found (404)

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index c5a529a..47d6d39 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -3,7 +3,7 @@ - +
    @@ -25,14 +25,14 @@
    - +
    @@ -161,15 +161,15 @@

    Contributor Code of Conduct

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index d4d3e84..5a45358 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -3,7 +3,7 @@ - +
    @@ -25,14 +25,14 @@
    - +
    @@ -155,15 +155,15 @@

    License

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 361389c..75901eb 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -3,7 +3,7 @@ - +
    @@ -25,14 +25,14 @@
    - +
    @@ -159,15 +159,15 @@

    MIT License

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/apple-touch-icon-120x120.png b/docs/apple-touch-icon-120x120.png index 61b24e0..40c7d7a 100644 Binary files a/docs/apple-touch-icon-120x120.png and b/docs/apple-touch-icon-120x120.png differ diff --git a/docs/apple-touch-icon-152x152.png b/docs/apple-touch-icon-152x152.png index e520295..c2bfcfe 100644 Binary files a/docs/apple-touch-icon-152x152.png and b/docs/apple-touch-icon-152x152.png differ diff --git a/docs/apple-touch-icon-180x180.png b/docs/apple-touch-icon-180x180.png index 28978ba..d78540d 100644 Binary files a/docs/apple-touch-icon-180x180.png and b/docs/apple-touch-icon-180x180.png differ diff --git a/docs/apple-touch-icon-60x60.png b/docs/apple-touch-icon-60x60.png index eb12813..6f456c9 100644 Binary files a/docs/apple-touch-icon-60x60.png and b/docs/apple-touch-icon-60x60.png differ diff --git a/docs/apple-touch-icon-76x76.png b/docs/apple-touch-icon-76x76.png index 957bdc7..94cf50d 100644 Binary files a/docs/apple-touch-icon-76x76.png and b/docs/apple-touch-icon-76x76.png differ diff --git a/docs/apple-touch-icon.png b/docs/apple-touch-icon.png index 70f26d0..605b7cc 100644 Binary files a/docs/apple-touch-icon.png and b/docs/apple-touch-icon.png differ diff --git a/docs/articles/index.html b/docs/articles/index.html index 804ded1..75049f7 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -1,9 +1,9 @@ -Articles • tabrArticles • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -194,15 +194,15 @@

    All vignettes

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-basics.html b/docs/articles/tabr-basics.html index 0b5b07d..5dc639c 100644 --- a/docs/articles/tabr-basics.html +++ b/docs/articles/tabr-basics.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -388,9 +386,7 @@

    Piping +

    @@ -403,16 +399,16 @@

    Piping

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-chordchart.html b/docs/articles/tabr-chordchart.html index 806c3b1..9eac737 100644 --- a/docs/articles/tabr-chordchart.html +++ b/docs/articles/tabr-chordchart.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -242,9 +240,7 @@

    Render chord chart - -

    +
    @@ -257,16 +253,16 @@

    Render chord chart

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-chords.html b/docs/articles/tabr-chords.html index 05804d5..97e5855 100644 --- a/docs/articles/tabr-chords.html +++ b/docs/articles/tabr-chords.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -426,9 +424,7 @@

    Overall picture - -

    +
    @@ -441,16 +437,16 @@

    Overall picture

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-engraving.html b/docs/articles/tabr-engraving.html index 58e1104..c39814b 100644 --- a/docs/articles/tabr-engraving.html +++ b/docs/articles/tabr-engraving.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -769,9 +767,7 @@

    Simplified syntax - -

    +
    @@ -784,16 +780,16 @@

    Simplified syntax

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-ex1.html b/docs/articles/tabr-ex1.html index df16df2..f0b93ad 100644 --- a/docs/articles/tabr-ex1.html +++ b/docs/articles/tabr-ex1.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -275,9 +273,7 @@

    Result +

    @@ -290,16 +286,16 @@

    Result

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-ex2.html b/docs/articles/tabr-ex2.html index 5a1ef9f..70a3f12 100644 --- a/docs/articles/tabr-ex2.html +++ b/docs/articles/tabr-ex2.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -335,9 +333,7 @@

    Result +

    @@ -350,16 +346,16 @@

    Result

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-ex3.html b/docs/articles/tabr-ex3.html index d7fc837..76fe987 100644 --- a/docs/articles/tabr-ex3.html +++ b/docs/articles/tabr-ex3.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -526,9 +524,7 @@

    Limitations - -

    +
    @@ -541,16 +537,16 @@

    Limitations

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-ex4.html b/docs/articles/tabr-ex4.html index c0e54e1..054fff3 100644 --- a/docs/articles/tabr-ex4.html +++ b/docs/articles/tabr-ex4.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -387,9 +385,7 @@

    Render the sheet music - -

    +
    @@ -402,16 +398,16 @@

    Render the sheet music

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-fretboard.html b/docs/articles/tabr-fretboard.html index b6c79ae..67e52df 100644 --- a/docs/articles/tabr-fretboard.html +++ b/docs/articles/tabr-fretboard.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -391,9 +389,7 @@

    Chord diagrams - -

    +
    @@ -406,16 +402,16 @@

    Chord diagrams

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-fretboard_files/figure-html/fb7b-1.png b/docs/articles/tabr-fretboard_files/figure-html/fb7b-1.png deleted file mode 100644 index 94865e4..0000000 Binary files a/docs/articles/tabr-fretboard_files/figure-html/fb7b-1.png and /dev/null differ diff --git a/docs/articles/tabr-fretboard_files/figure-html/fb8-2.png b/docs/articles/tabr-fretboard_files/figure-html/fb8-2.png deleted file mode 100644 index ecae088..0000000 Binary files a/docs/articles/tabr-fretboard_files/figure-html/fb8-2.png and /dev/null differ diff --git a/docs/articles/tabr-helpers.html b/docs/articles/tabr-helpers.html index e9cd89c..b1f223d 100644 --- a/docs/articles/tabr-helpers.html +++ b/docs/articles/tabr-helpers.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -468,9 +466,7 @@

    Tuplets - -

    +
    @@ -483,16 +479,16 @@

    Tuplets

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-phrases.html b/docs/articles/tabr-phrases.html index 400987f..1551282 100644 --- a/docs/articles/tabr-phrases.html +++ b/docs/articles/tabr-phrases.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -839,9 +837,7 @@

    Chords +

    @@ -854,16 +850,16 @@

    Chords

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-prog-chords.html b/docs/articles/tabr-prog-chords.html index 79b16f4..ecd0d58 100644 --- a/docs/articles/tabr-prog-chords.html +++ b/docs/articles/tabr-prog-chords.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -756,9 +754,7 @@

    Fretboard diagrams - -

    +
    @@ -771,16 +767,16 @@

    Fretboard diagrams

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-prog-converters.html b/docs/articles/tabr-prog-converters.html index f14febb..10d5289 100644 --- a/docs/articles/tabr-prog-converters.html +++ b/docs/articles/tabr-prog-converters.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -568,9 +566,7 @@

    Wrapping up - -

    +
    @@ -583,16 +579,16 @@

    Wrapping up

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-prog-music.html b/docs/articles/tabr-prog-music.html index 5ade06f..8276449 100644 --- a/docs/articles/tabr-prog-music.html +++ b/docs/articles/tabr-prog-music.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -507,9 +505,7 @@

    Working with music objects - -

    +
    @@ -522,16 +518,16 @@

    Working with music objects

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-prog-noteinfo.html b/docs/articles/tabr-prog-noteinfo.html index 8f0b8c2..f2a87c5 100644 --- a/docs/articles/tabr-prog-noteinfo.html +++ b/docs/articles/tabr-prog-noteinfo.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -332,9 +330,7 @@

    Use cases - -

    +
    @@ -347,16 +343,16 @@

    Use cases

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-prog-notes.html b/docs/articles/tabr-prog-notes.html index 7ff0e84..57708fb 100644 --- a/docs/articles/tabr-prog-notes.html +++ b/docs/articles/tabr-prog-notes.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -744,9 +742,7 @@

    Transpose - -

    +
    @@ -759,16 +755,16 @@

    Transpose

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-prog-nw.html b/docs/articles/tabr-prog-nw.html index 0f3e248..4e85ec2 100644 --- a/docs/articles/tabr-prog-nw.html +++ b/docs/articles/tabr-prog-nw.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -398,9 +396,7 @@

    Notable phrases - -

    +
    @@ -413,16 +409,16 @@

    Notable phrases

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-prog-scales.html b/docs/articles/tabr-prog-scales.html index 2db17e6..a2c8bfa 100644 --- a/docs/articles/tabr-prog-scales.html +++ b/docs/articles/tabr-prog-scales.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -494,9 +492,7 @@

    Musical intervals - -

    +
    @@ -509,16 +505,16 @@

    Musical intervals

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-repeats.html b/docs/articles/tabr-repeats.html index e3a7dca..882c92c 100644 --- a/docs/articles/tabr-repeats.html +++ b/docs/articles/tabr-repeats.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -414,9 +412,7 @@

    Multiple alternate endings - -

    +
    @@ -429,16 +425,16 @@

    Multiple alternate endings

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-snippets.html b/docs/articles/tabr-snippets.html index 2ecf1e3..a639f57 100644 --- a/docs/articles/tabr-snippets.html +++ b/docs/articles/tabr-snippets.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -286,9 +284,7 @@

    Additional wrappers - -

    +
    @@ -301,16 +297,16 @@

    Additional wrappers

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-tracks-scores.html b/docs/articles/tabr-tracks-scores.html index 536ffb4..a360603 100644 --- a/docs/articles/tabr-tracks-scores.html +++ b/docs/articles/tabr-tracks-scores.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -604,9 +602,7 @@

    Score examples - -

    +
    @@ -619,16 +615,16 @@

    Score examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/articles/tabr-tunings.html b/docs/articles/tabr-tunings.html index de7e2de..0fa1eb3 100644 --- a/docs/articles/tabr-tunings.html +++ b/docs/articles/tabr-tunings.html @@ -12,22 +12,20 @@ - + - - - +
    @@ -50,14 +48,14 @@
  • - + Home
    • - +
    @@ -333,9 +331,7 @@

    Current limitations - -

    +
    @@ -348,16 +344,16 @@

    Current limitations

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/authors.html b/docs/authors.html index 27c634f..6051c51 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -3,7 +3,7 @@ - +
    @@ -25,14 +25,14 @@
    - +
    @@ -137,7 +137,7 @@

    Authors and Citation

    - +

    • Matthew Leonawicz. Author, maintainer.

      @@ -153,13 +153,13 @@

      Citation

      Leonawicz M (2024). tabr: Music Notation Syntax, Manipulation, Analysis and Transcription in R. -R package version 0.5.0, https://github.com/leonawicz/tabr. +R package version 0.5.1, https://github.com/leonawicz/tabr. 

      @Manual{,
   title = {tabr: Music Notation Syntax, Manipulation, Analysis and Transcription in R},
   author = {Matthew Leonawicz},
   year = {2024},
-  note = {R package version 0.5.0},
+  note = {R package version 0.5.1},
   url = {https://github.com/leonawicz/tabr},
 }
      @@ -174,15 +174,15 @@

      Citation

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/favicon-16x16.png b/docs/favicon-16x16.png index cd2cb46..33f04b1 100644 Binary files a/docs/favicon-16x16.png and b/docs/favicon-16x16.png differ diff --git a/docs/favicon-32x32.png b/docs/favicon-32x32.png index 346be77..c477b2d 100644 Binary files a/docs/favicon-32x32.png and b/docs/favicon-32x32.png differ diff --git a/docs/favicon.ico b/docs/favicon.ico index f6450ab..6438f01 100644 Binary files a/docs/favicon.ico and b/docs/favicon.ico differ diff --git a/docs/index.html b/docs/index.html index 230254f..c363b3d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -27,7 +27,7 @@ - +
    @@ -50,14 +50,14 @@
  • - + Home
    • - +
    @@ -183,7 +183,7 @@

    Overview

    Citation

    -

    Matthew Leonawicz (2024). tabr: Music Notation Syntax, Manipulation, Analysis and Transcription in R. R package version 0.5.0. https://CRAN.R-project.org/package=tabr

    +

    Matthew Leonawicz (2024). tabr: Music Notation Syntax, Manipulation, Analysis and Transcription in R. R package version 0.5.1. https://CRAN.R-project.org/package=tabr

    Contribute @@ -598,9 +598,9 @@

    Dev status

    • Project Status: Active – The project has reached a stable, usable state and is being actively developed.
    • R-CMD-check
      • -
    • Codecov test coverage
      • -
    • CRAN status
      • -
    • CRAN downloads
      • +
    • Codecov test coverage
      • +
    • CRAN status
      • +
    • CRAN downloads
    • Github Stars
    @@ -616,16 +616,16 @@

    Dev status

    -

    Site built with pkgdown 2.0.9.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/news/index.html b/docs/news/index.html index bf6aad1..6795e7e 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -1,9 +1,9 @@ -Changelog • tabrChangelog • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -138,8 +138,13 @@

    Changelog

    -

    tabr 0.5.0

    +

    tabr 0.5.1

    +
    • Minor updates.
      • +
    +
    +

    tabr 0.5.02024-06-29

    • Refactored and made improvements to plot_fretboard() and plot_chord() including the addition of fret_labels and fret_offset arguments.
      • +
    • Updated tests and documentation.

    tabr 0.4.92023-09-21

    @@ -321,15 +326,15 @@

    tabr 0.1.0 -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 059fefb..529af55 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,5 +1,5 @@ -pandoc: 3.1.1 -pkgdown: 2.0.7 +pandoc: 3.1.11 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: tabr-basics: tabr-basics.html @@ -24,8 +24,7 @@ articles: tabr-snippets: tabr-snippets.html tabr-tracks-scores: tabr-tracks-scores.html tabr-tunings: tabr-tunings.html -last_built: 2023-09-21T23:45Z +last_built: 2024-09-10T23:52Z urls: reference: https://leonawicz.github.io/tabr/reference article: https://leonawicz.github.io/tabr/articles - diff --git a/docs/reference/!=.noteworthy.html b/docs/reference/!=.noteworthy.html new file mode 100644 index 0000000..05b87e0 --- /dev/null +++ b/docs/reference/!=.noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/==.noteworthy.html b/docs/reference/==.noteworthy.html new file mode 100644 index 0000000..05b87e0 --- /dev/null +++ b/docs/reference/==.noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/[.lyrics.html b/docs/reference/[.lyrics.html new file mode 100644 index 0000000..36fdc3a --- /dev/null +++ b/docs/reference/[.lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/[.music.html b/docs/reference/[.music.html new file mode 100644 index 0000000..36fdc3a --- /dev/null +++ b/docs/reference/[.music.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/[.noteinfo.html b/docs/reference/[.noteinfo.html new file mode 100644 index 0000000..36fdc3a --- /dev/null +++ b/docs/reference/[.noteinfo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/[.noteworthy.html b/docs/reference/[.noteworthy.html new file mode 100644 index 0000000..36fdc3a --- /dev/null +++ b/docs/reference/[.noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/[[.lyrics.html b/docs/reference/[[.lyrics.html new file mode 100644 index 0000000..a01dc32 --- /dev/null +++ b/docs/reference/[[.lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/[[.music.html b/docs/reference/[[.music.html new file mode 100644 index 0000000..a01dc32 --- /dev/null +++ b/docs/reference/[[.music.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/[[.noteinfo.html b/docs/reference/[[.noteinfo.html new file mode 100644 index 0000000..a01dc32 --- /dev/null +++ b/docs/reference/[[.noteinfo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/[[.noteworthy.html b/docs/reference/[[.noteworthy.html new file mode 100644 index 0000000..a01dc32 --- /dev/null +++ b/docs/reference/[[.noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/accidental_type.html b/docs/reference/accidental_type.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/accidental_type.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/append_phrases.html b/docs/reference/append_phrases.html index 3e9f15d..b44c944 100644 --- a/docs/reference/append_phrases.html +++ b/docs/reference/append_phrases.html @@ -1,10 +1,10 @@ -Concatenate and repeat — append_phrases • tabrConcatenate and repeat — append_phrases • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -152,23 +152,23 @@

    Concatenate and repeat

    Arguments

    -
    ...
    + + +
    ...

    character, phrase or non-phrase string.

    -
    x
    +
    x

    character, phrase or non-phrase string.

    -
    n
    +
    n

    integer, number of repetitions.

    Value

    - - -

    phrase on non-phrase character string, noteworthy string if +

    phrase on non-phrase character string, noteworthy string if applicable.

    @@ -238,15 +238,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/articulations.html b/docs/reference/articulations.html index 517a19a..5d626c1 100644 --- a/docs/reference/articulations.html +++ b/docs/reference/articulations.html @@ -1,10 +1,10 @@ -Single note articulations and syntax — articulations • tabrSingle note articulations and syntax — articulations • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -165,15 +165,15 @@

    Format

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/as_integer_octaves.html b/docs/reference/as_integer_octaves.html new file mode 100644 index 0000000..3899d17 --- /dev/null +++ b/docs/reference/as_integer_octaves.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/as_lyrics.html b/docs/reference/as_lyrics.html new file mode 100644 index 0000000..ecce48d --- /dev/null +++ b/docs/reference/as_lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/as_music.html b/docs/reference/as_music.html new file mode 100644 index 0000000..9afc2a8 --- /dev/null +++ b/docs/reference/as_music.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/as_music_df.html b/docs/reference/as_music_df.html index 09eb16b..7b645fb 100644 --- a/docs/reference/as_music_df.html +++ b/docs/reference/as_music_df.html @@ -1,10 +1,10 @@ -Noteworthy string to data frame — as_music_df • tabrNoteworthy string to data frame — as_music_df • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -157,41 +157,41 @@

    Noteworthy string to data frame

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string. Alternatively, a music object or a phrase object, in which case info is ignored.

    -
    info
    +
    info

    NULL or character, a note info string.

    -
    key
    +
    key

    character, key signature, only required for inclusion of scale degrees.

    -
    scale
    +
    scale

    character, defaults to "diatonic". Only used in conjunction with key, this can be used to alter scale degrees. Not any arbitrary combination of valid key and valid scale is valid. See scale_degree().

    -
    chords
    +
    chords

    character, how to structure columns containing multiple values per chord/row of data frame. See details.

    -
    si_format
    +
    si_format

    character, format for scale intervals. See scale_interval().

    Value

    - - -

    a tibble data frame

    +

    a tibble data frame

    Details

    @@ -314,15 +314,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/as_noteinfo.html b/docs/reference/as_noteinfo.html new file mode 100644 index 0000000..ecb90c9 --- /dev/null +++ b/docs/reference/as_noteinfo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/as_noteworthy.html b/docs/reference/as_noteworthy.html new file mode 100644 index 0000000..3d34843 --- /dev/null +++ b/docs/reference/as_noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/as_phrase.html b/docs/reference/as_phrase.html new file mode 100644 index 0000000..f75d458 --- /dev/null +++ b/docs/reference/as_phrase.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/as_space_time.html b/docs/reference/as_space_time.html new file mode 100644 index 0000000..3899d17 --- /dev/null +++ b/docs/reference/as_space_time.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/as_tick_octaves.html b/docs/reference/as_tick_octaves.html new file mode 100644 index 0000000..3899d17 --- /dev/null +++ b/docs/reference/as_tick_octaves.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/as_vector_time.html b/docs/reference/as_vector_time.html new file mode 100644 index 0000000..3899d17 --- /dev/null +++ b/docs/reference/as_vector_time.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/bpm.html b/docs/reference/bpm.html new file mode 100644 index 0000000..9d517ac --- /dev/null +++ b/docs/reference/bpm.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/c.lyrics.html b/docs/reference/c.lyrics.html new file mode 100644 index 0000000..dca972c --- /dev/null +++ b/docs/reference/c.lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/c.music.html b/docs/reference/c.music.html new file mode 100644 index 0000000..dca972c --- /dev/null +++ b/docs/reference/c.music.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/c.noteinfo.html b/docs/reference/c.noteinfo.html new file mode 100644 index 0000000..dca972c --- /dev/null +++ b/docs/reference/c.noteinfo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/c.noteworthy.html b/docs/reference/c.noteworthy.html new file mode 100644 index 0000000..dca972c --- /dev/null +++ b/docs/reference/c.noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/c.phrase.html b/docs/reference/c.phrase.html new file mode 100644 index 0000000..dca972c --- /dev/null +++ b/docs/reference/c.phrase.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/cents_to_ratio.html b/docs/reference/cents_to_ratio.html new file mode 100644 index 0000000..d33d72d --- /dev/null +++ b/docs/reference/cents_to_ratio.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord-compare.html b/docs/reference/chord-compare.html index 28bc109..b22e0b3 100644 --- a/docs/reference/chord-compare.html +++ b/docs/reference/chord-compare.html @@ -1,9 +1,9 @@ -Rank, order and sort chords and notes — chord-compare • tabrRank, order and sort chords and notes — chord-compare • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -152,28 +152,28 @@

    Rank, order and sort chords and notes

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string.

    -
    pitch
    +
    pitch

    character, how ranking of chords is determined; lowest pitch, mean pitch, or highest pitch.

    -
    ...
    +
    ...

    additional arguments passed to rank() or order().

    -
    decreasing
    +
    decreasing

    logical, sort in decreasing order.

    Value

    - - -

    integer for rank and order, character for sort

    +

    integer for rank and order, character for sort

    Details

    @@ -214,15 +214,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/chord-filter.html b/docs/reference/chord-filter.html index e5d0825..d93d2e4 100644 --- a/docs/reference/chord-filter.html +++ b/docs/reference/chord-filter.html @@ -1,9 +1,9 @@ -Extract notes from chords — chord-filter • tabrExtract notes from chords — chord-filter • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -152,20 +152,20 @@

    Extract notes from chords

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string.

    -
    index
    +
    index

    integer, the order of a note in a chord by pitch (not scale degrees).

    Value

    - - -

    a noteworthy string

    +

    a noteworthy string

    Details

    @@ -216,15 +216,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/chord-mapping.html b/docs/reference/chord-mapping.html index 81cf7dd..4fc608e 100644 --- a/docs/reference/chord-mapping.html +++ b/docs/reference/chord-mapping.html @@ -1,9 +1,9 @@ -Chord mapping — chord-mapping • tabrChord mapping — chord-mapping • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -196,54 +196,54 @@

    Chord mapping

    Arguments

    -
    name
    + + +
    name

    character, chord name in tabr format, e.g., "bM b_m b_m7#5", etc.

    -
    root_octave
    +
    root_octave

    integer, optional filter for chords whose root note is in a set of octave numbers. May be a vector.

    -
    root_fret
    +
    root_fret

    integer, optional filter for chords whose root note matches a specific fret. May be a vector.

    -
    min_fret
    +
    min_fret

    integer, optional filter for chords whose notes are all at or above a specific fret. May be a vector.

    -
    bass_string
    +
    bass_string

    integer, optional filter for chords whose lowest pitch string matches a specific string, 6, 5, or 4. May be a vector.

    -
    open
    +
    open

    logical, optional filter for open and movable chords. NULL retains both types.

    -
    key
    +
    key

    character, key signature, used to enforce type of accidentals.

    -
    ignore_octave
    +
    ignore_octave

    logical, if TRUE, functions like gc_info() and gc_fretboard() return more results.

    -
    notes
    +
    notes

    character, a noteworthy string.

    Value

    - - -

    various, see details regarding each function.

    +

    various, see details regarding each function.

    Details

    @@ -362,15 +362,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/chord_11.html b/docs/reference/chord_11.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_11.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_13.html b/docs/reference/chord_13.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_13.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_5.html b/docs/reference/chord_5.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_5.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_7s11.html b/docs/reference/chord_7s11.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_7s11.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_7s5.html b/docs/reference/chord_7s5.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_7s5.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_7s9.html b/docs/reference/chord_7s9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_7s9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_add9.html b/docs/reference/chord_add9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_add9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_arpeggiate.html b/docs/reference/chord_arpeggiate.html index cc4a6ef..8334af9 100644 --- a/docs/reference/chord_arpeggiate.html +++ b/docs/reference/chord_arpeggiate.html @@ -1,9 +1,9 @@ -Arpeggiate a chord — chord_arpeggiate • tabrArpeggiate a chord — chord_arpeggiate • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -154,35 +154,35 @@

    Arpeggiate a chord

    Arguments

    -
    chord
    + + +
    chord

    character, a single chord.

    -
    n
    +
    n

    integer, number of steps, negative indicates reverse direction (decreasing pitch).

    -
    by
    +
    by

    whether each of the n steps refers to individual notes in the chord (an inversion) or raising the entire chord in its given position by one octave.

    -
    broken
    +
    broken

    logical, return result as an arpeggio of broken chords.

    -
    collapse
    +
    collapse

    logical, collapse result into a single string ready for phrase construction.

    Value

    - - -

    character

    +

    character

    Details

    @@ -222,15 +222,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/chord_aug.html b/docs/reference/chord_aug.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_aug.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_break.html b/docs/reference/chord_break.html index f0cdbae..34cc062 100644 --- a/docs/reference/chord_break.html +++ b/docs/reference/chord_break.html @@ -1,9 +1,9 @@ -Broken chords — chord_break • tabrBroken chords — chord_break • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,15 +148,15 @@

    Broken chords

    Arguments

    -
    notes
    + + +
    notes

    character, noteworthy string that may contain chords.

    Value

    - - -

    character

    +

    character

    @@ -179,15 +179,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/chord_def.html b/docs/reference/chord_def.html index d7eac5a..4b8ff72 100644 --- a/docs/reference/chord_def.html +++ b/docs/reference/chord_def.html @@ -1,9 +1,9 @@ -Define chords — chord_def • tabrDefine chords — chord_def • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,34 +148,34 @@

    Define chords

    Arguments

    -
    fret
    + + +
    fret

    integer vector defining fretted chord. See details.

    -
    id
    +
    id

    character, the chord type. See details.

    -
    optional
    +
    optional

    NA when all notes required. Otherwise an integer vector giving the indices offret that are considered optional notes for the chord.

    -
    tuning
    +
    tuning

    character, string tuning. See tunings for predefined tunings. Custom tunings are specified with a similar value string.

    -
    ...
    +
    ...

    additional arguments passed to transpose().

    Value

    - - -

    a data frame

    +

    a data frame

    Details

    @@ -245,15 +245,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/chord_degree.html b/docs/reference/chord_degree.html new file mode 100644 index 0000000..a9b1576 --- /dev/null +++ b/docs/reference/chord_degree.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_dim.html b/docs/reference/chord_dim.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_dim.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_dim7.html b/docs/reference/chord_dim7.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_dim7.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_dom7.html b/docs/reference/chord_dom7.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_dom7.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_dom9.html b/docs/reference/chord_dom9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_dom9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_freq.html b/docs/reference/chord_freq.html new file mode 100644 index 0000000..f7c6798 --- /dev/null +++ b/docs/reference/chord_freq.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_invert.html b/docs/reference/chord_invert.html index 7c2722d..70fd053 100644 --- a/docs/reference/chord_invert.html +++ b/docs/reference/chord_invert.html @@ -1,12 +1,12 @@ -Chord inversion — chord_invert • tabrChord inversion — chord_invert • tabr - +
    @@ -28,14 +28,14 @@
    - +
    @@ -154,24 +154,24 @@

    Chord inversion

    Arguments

    -
    chord
    + + +
    chord

    character, a single chord.

    -
    n
    +
    n

    inversion.

    -
    limit
    +
    limit

    logical, limit inversions in either direction to one less than the number of notes in the chord.

    Value

    - - -

    character

    +

    character

    Details

    @@ -216,15 +216,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/chord_is_major.html b/docs/reference/chord_is_major.html index bd133a0..f9e5dc8 100644 --- a/docs/reference/chord_is_major.html +++ b/docs/reference/chord_is_major.html @@ -1,9 +1,9 @@ -Check if chords are major or minor — chord_is_major • tabrCheck if chords are major or minor — chord_is_major • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -150,15 +150,15 @@

    Check if chords are major or minor

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string.

    Value

    - - -

    logical vector

    +

    logical vector

    Details

    @@ -199,15 +199,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/chord_is_minor.html b/docs/reference/chord_is_minor.html new file mode 100644 index 0000000..8aac326 --- /dev/null +++ b/docs/reference/chord_is_minor.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_m7b5.html b/docs/reference/chord_m7b5.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_m7b5.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_madd9.html b/docs/reference/chord_madd9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_madd9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_maj.html b/docs/reference/chord_maj.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_maj.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_maj11.html b/docs/reference/chord_maj11.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_maj11.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_maj13.html b/docs/reference/chord_maj13.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_maj13.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_maj6.html b/docs/reference/chord_maj6.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_maj6.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_maj7.html b/docs/reference/chord_maj7.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_maj7.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_maj7s11.html b/docs/reference/chord_maj7s11.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_maj7s11.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_maj9.html b/docs/reference/chord_maj9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_maj9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_min.html b/docs/reference/chord_min.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_min.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_min11.html b/docs/reference/chord_min11.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_min11.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_min13.html b/docs/reference/chord_min13.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_min13.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_min6.html b/docs/reference/chord_min6.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_min6.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_min7.html b/docs/reference/chord_min7.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_min7.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_min9.html b/docs/reference/chord_min9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_min9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_order.html b/docs/reference/chord_order.html new file mode 100644 index 0000000..a565c6d --- /dev/null +++ b/docs/reference/chord_order.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_rank.html b/docs/reference/chord_rank.html new file mode 100644 index 0000000..a565c6d --- /dev/null +++ b/docs/reference/chord_rank.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_root.html b/docs/reference/chord_root.html new file mode 100644 index 0000000..2215944 --- /dev/null +++ b/docs/reference/chord_root.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_semitones.html b/docs/reference/chord_semitones.html new file mode 100644 index 0000000..f7c6798 --- /dev/null +++ b/docs/reference/chord_semitones.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_set.html b/docs/reference/chord_set.html index 6bb8e6a..3fb7fa9 100644 --- a/docs/reference/chord_set.html +++ b/docs/reference/chord_set.html @@ -1,9 +1,9 @@ -Generate a chord set — chord_set • tabrGenerate a chord set — chord_set • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,27 +148,27 @@

    Generate a chord set

    Arguments

    -
    x
    + + +
    x

    character, n-string chord description from lowest to highest pitch, strings n through 1. E.g., "xo221o". You can use spaces or semicolons when 2-digit fret numbers are present, e.g., "8 10 10 9 o". Do not mix formats. Leading x are inferred if the number of entries is less than n.

    -
    id
    +
    id

    character, the name of the chord in LilyPond readable format, e.g., "a:m". Ignored if x is already a named vector.

    -
    n
    +
    n

    number of instrument strings.

    Value

    - - -

    a named list.

    +

    a named list.

    Details

    @@ -211,15 +211,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/chord_size.html b/docs/reference/chord_size.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/chord_size.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_slice.html b/docs/reference/chord_slice.html new file mode 100644 index 0000000..2215944 --- /dev/null +++ b/docs/reference/chord_slice.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_sort.html b/docs/reference/chord_sort.html new file mode 100644 index 0000000..a565c6d --- /dev/null +++ b/docs/reference/chord_sort.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_sus2.html b/docs/reference/chord_sus2.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_sus2.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_sus4.html b/docs/reference/chord_sus4.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/chord_sus4.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chord_top.html b/docs/reference/chord_top.html new file mode 100644 index 0000000..2215944 --- /dev/null +++ b/docs/reference/chord_top.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/chords.html b/docs/reference/chords.html index 5eeeb0e..a6d2048 100644 --- a/docs/reference/chords.html +++ b/docs/reference/chords.html @@ -1,9 +1,9 @@ -Chord constructors — chords • tabrChord constructors — chords • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -262,23 +262,23 @@

    Chord constructors

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string of chord root notes.

    -
    key
    +
    key

    key signature. See details.

    -
    octaves
    +
    octaves

    character, passed to transpose().

    Value

    - - -

    character

    +

    character

    Details

    @@ -331,15 +331,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/distinct_notes.html b/docs/reference/distinct_notes.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/distinct_notes.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/distinct_octaves.html b/docs/reference/distinct_octaves.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/distinct_octaves.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/distinct_pitches.html b/docs/reference/distinct_pitches.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/distinct_pitches.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/double-bracket.html b/docs/reference/double-bracket.html index 232251c..c9f88d9 100644 --- a/docs/reference/double-bracket.html +++ b/docs/reference/double-bracket.html @@ -1,10 +1,10 @@ -Double bracket methods for tabr classes — double-bracket • tabrDouble bracket methods for tabr classes — double-bracket • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -145,42 +145,44 @@

    Double bracket methods for tabr classes

    - 
    # S3 method for noteworthy
-[[(x, i)
-
-# S3 method for noteinfo
-[[(x, i)
-
-# S3 method for music
-[[(x, i)
-
-# S3 method for lyrics
-[[(x, i)
-
-# S3 method for noteworthy
-[[(x, i) <- value
-
-# S3 method for noteinfo
-[[(x, i) <- value
-
-# S3 method for music
-[[(x, i) <- value
-
-# S3 method for lyrics
-[[(x, i) <- value
    + 
    # S3 method for class 'noteworthy'
+x[[i]]
+
+# S3 method for class 'noteinfo'
+x[[i]]
+
+# S3 method for class 'music'
+x[[i]]
+
+# S3 method for class 'lyrics'
+x[[i]]
+
+# S3 method for class 'noteworthy'
+x[[i]] <- value
+
+# S3 method for class 'noteinfo'
+x[[i]] <- value
+
+# S3 method for class 'music'
+x[[i]] <- value
+
+# S3 method for class 'lyrics'
+x[[i]] <- value

    Arguments

    -
    x
    + + +
    x

    object.

    -
    i
    +
    i

    index.

    -
    value
    +
    value

    values to assign at index.

    @@ -234,15 +236,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/duration_to_ticks.html b/docs/reference/duration_to_ticks.html new file mode 100644 index 0000000..12a353e --- /dev/null +++ b/docs/reference/duration_to_ticks.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/dyad.html b/docs/reference/dyad.html index 324a833..f213239 100644 --- a/docs/reference/dyad.html +++ b/docs/reference/dyad.html @@ -1,9 +1,9 @@ -Construct a dyad — dyad • tabrConstruct a dyad — dyad • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -155,30 +155,30 @@

    Construct a dyad

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string, single notes only, no chords. Number of timesteps must equal the length of interval.

    -
    interval
    +
    interval

    integer or character vector; semitones or interval ID, respectively. See details.

    -
    reverse
    +
    reverse

    logical, reverse the transposition direction. Useful when interval is character.

    -
    octaves, accidentals, key
    +
    octaves, accidentals, key

    See transpose().

    Value

    - - -

    character

    +

    character

    Details

    @@ -245,15 +245,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/flatten_sharp.html b/docs/reference/flatten_sharp.html new file mode 100644 index 0000000..3899d17 --- /dev/null +++ b/docs/reference/flatten_sharp.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/freq_pitch.html b/docs/reference/freq_pitch.html new file mode 100644 index 0000000..f7c6798 --- /dev/null +++ b/docs/reference/freq_pitch.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/freq_ratio.html b/docs/reference/freq_ratio.html index df3267a..7d09210 100644 --- a/docs/reference/freq_ratio.html +++ b/docs/reference/freq_ratio.html @@ -1,9 +1,9 @@ -Frequency ratios — freq_ratio • tabrFrequency ratios — freq_ratio • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,12 +148,14 @@

    Frequency ratios

    Arguments

    -
    x
    + + +
    x

    noteworthy or music object, or a numeric vector or list of numeric vectors for frequencies.

    -
    ...
    +
    ...

    additional arguments: ratios, which is one of "all" (default), "root", or "range" for filtering results. For frequency input, you may also specify octaves and accidentals. @@ -162,9 +164,7 @@

    Arguments

    Value

    - - -

    a tibble data frame

    +

    a tibble data frame

    Details

    @@ -245,15 +245,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/freq_semitones.html b/docs/reference/freq_semitones.html new file mode 100644 index 0000000..f7c6798 --- /dev/null +++ b/docs/reference/freq_semitones.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/from_chorrrds.html b/docs/reference/from_chorrrds.html new file mode 100644 index 0000000..d4fc022 --- /dev/null +++ b/docs/reference/from_chorrrds.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/from_music21.html b/docs/reference/from_music21.html new file mode 100644 index 0000000..d4fc022 --- /dev/null +++ b/docs/reference/from_music21.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/gc_fretboard.html b/docs/reference/gc_fretboard.html new file mode 100644 index 0000000..1c711d0 --- /dev/null +++ b/docs/reference/gc_fretboard.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/gc_info.html b/docs/reference/gc_info.html new file mode 100644 index 0000000..1c711d0 --- /dev/null +++ b/docs/reference/gc_info.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/gc_is_known.html b/docs/reference/gc_is_known.html new file mode 100644 index 0000000..1c711d0 --- /dev/null +++ b/docs/reference/gc_is_known.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/gc_name_mod.html b/docs/reference/gc_name_mod.html new file mode 100644 index 0000000..1c711d0 --- /dev/null +++ b/docs/reference/gc_name_mod.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/gc_name_root.html b/docs/reference/gc_name_root.html new file mode 100644 index 0000000..1c711d0 --- /dev/null +++ b/docs/reference/gc_name_root.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/gc_name_split.html b/docs/reference/gc_name_split.html new file mode 100644 index 0000000..1c711d0 --- /dev/null +++ b/docs/reference/gc_name_split.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/gc_notes.html b/docs/reference/gc_notes.html new file mode 100644 index 0000000..1c711d0 --- /dev/null +++ b/docs/reference/gc_notes.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/gc_notes_to_fb.html b/docs/reference/gc_notes_to_fb.html new file mode 100644 index 0000000..1c711d0 --- /dev/null +++ b/docs/reference/gc_notes_to_fb.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/guitarChords.html b/docs/reference/guitarChords.html index e11d535..8ce3e11 100644 --- a/docs/reference/guitarChords.html +++ b/docs/reference/guitarChords.html @@ -1,9 +1,9 @@ -Predefined guitar chords — guitarChords • tabrPredefined guitar chords — guitarChords • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -163,15 +163,15 @@

    Format

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/head.lyrics.html b/docs/reference/head.lyrics.html new file mode 100644 index 0000000..498f37c --- /dev/null +++ b/docs/reference/head.lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/head.music.html b/docs/reference/head.music.html new file mode 100644 index 0000000..498f37c --- /dev/null +++ b/docs/reference/head.music.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/head.noteinfo.html b/docs/reference/head.noteinfo.html new file mode 100644 index 0000000..498f37c --- /dev/null +++ b/docs/reference/head.noteinfo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/head.noteworthy.html b/docs/reference/head.noteworthy.html new file mode 100644 index 0000000..498f37c --- /dev/null +++ b/docs/reference/head.noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/hp.html b/docs/reference/hp.html index 2508257..f9be2d4 100644 --- a/docs/reference/hp.html +++ b/docs/reference/hp.html @@ -1,9 +1,9 @@ -Hammer ons and pull offs — hp • tabrHammer ons and pull offs — hp • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,16 +148,16 @@

    Hammer ons and pull offs

    Arguments

    -
    ...
    + + +
    ...

    character, note durations. Numeric is allowed for lists of single inputs. See examples.

    Value

    - - -

    character.

    +

    character.

    Details

    @@ -189,15 +189,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/index.html b/docs/reference/index.html index 39426f7..32611e8 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,9 +1,9 @@ -Function reference • tabrPackage index • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -141,9 +141,13 @@

    Package

    tabr tabr-package

    +

    tabr-package tabr

    + +

    tabr: Music Notation Syntax, Manipulation, Analysis and Transcription in R

    + +

    tabr-details

    -

    tabr: Music notation syntax, manipulation, analysis and transcription in R.

    +

    tabr: Additional Detals

    Class methods

    S3 methods implemented for tabr classes

    @@ -561,15 +565,15 @@

    Datasets

    pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/info_annotation.html b/docs/reference/info_annotation.html new file mode 100644 index 0000000..d21cacb --- /dev/null +++ b/docs/reference/info_annotation.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/info_articulation.html b/docs/reference/info_articulation.html new file mode 100644 index 0000000..d21cacb --- /dev/null +++ b/docs/reference/info_articulation.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/info_bend.html b/docs/reference/info_bend.html new file mode 100644 index 0000000..d21cacb --- /dev/null +++ b/docs/reference/info_bend.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/info_dotted.html b/docs/reference/info_dotted.html new file mode 100644 index 0000000..d21cacb --- /dev/null +++ b/docs/reference/info_dotted.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/info_double_dotted.html b/docs/reference/info_double_dotted.html new file mode 100644 index 0000000..d21cacb --- /dev/null +++ b/docs/reference/info_double_dotted.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/info_duration.html b/docs/reference/info_duration.html new file mode 100644 index 0000000..d21cacb --- /dev/null +++ b/docs/reference/info_duration.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/info_single_dotted.html b/docs/reference/info_single_dotted.html new file mode 100644 index 0000000..d21cacb --- /dev/null +++ b/docs/reference/info_single_dotted.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/info_slide.html b/docs/reference/info_slide.html new file mode 100644 index 0000000..d21cacb --- /dev/null +++ b/docs/reference/info_slide.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/info_slur_off.html b/docs/reference/info_slur_off.html new file mode 100644 index 0000000..d21cacb --- /dev/null +++ b/docs/reference/info_slur_off.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/info_slur_on.html b/docs/reference/info_slur_on.html new file mode 100644 index 0000000..d21cacb --- /dev/null +++ b/docs/reference/info_slur_on.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/informable.html b/docs/reference/informable.html new file mode 100644 index 0000000..ecb90c9 --- /dev/null +++ b/docs/reference/informable.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/interval_semitones.html b/docs/reference/interval_semitones.html index 0689607..bf95be7 100644 --- a/docs/reference/interval_semitones.html +++ b/docs/reference/interval_semitones.html @@ -1,11 +1,11 @@ -Interval semitones — interval_semitones • tabrInterval semitones — interval_semitones • tabr - +
    @@ -27,14 +27,14 @@
    - +
    @@ -152,15 +152,15 @@

    Interval semitones

    Arguments

    -
    interval
    + + +
    interval

    character, interval ID. See details.

    Value

    - - -

    integer

    +

    integer

    See also

    @@ -189,15 +189,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/intervals.html b/docs/reference/intervals.html index 2682642..848d5f3 100644 --- a/docs/reference/intervals.html +++ b/docs/reference/intervals.html @@ -1,9 +1,9 @@ -Interval helpers — intervals • tabrInterval helpers — intervals • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -167,41 +167,41 @@

    Interval helpers

    Arguments

    -
    use_root
    + + +
    use_root

    logical, use lowest pitch in chord for pitch intervals or scale intervals between adjacent timesteps. Otherwise intervals involving chords are NA.

    -
    notes, notes1, notes2
    +
    notes, notes1, notes2

    character, a noteworthy string. notes1 and notes2 must have equal number of timesteps.

    -
    n
    +
    n

    integer, size of lag.

    -
    trim
    +
    trim

    logical, trim the n leading NA values from lagged intervals.

    -
    format
    +
    format

    character, format of the scale notation: major/minor/perfect, augmented/diminished, and respective abbreviations. See argument options in defaults.

    -
    tuning
    +
    tuning

    character, string tuning.

    Value

    - - -

    a musical interval, integer or character depending on the function.

    +

    a musical interval, integer or character depending on the function.

    Details

    @@ -276,15 +276,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/is_chord.html b/docs/reference/is_chord.html new file mode 100644 index 0000000..3d34843 --- /dev/null +++ b/docs/reference/is_chord.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/is_diatonic.html b/docs/reference/is_diatonic.html index eb59fa6..90dde04 100644 --- a/docs/reference/is_diatonic.html +++ b/docs/reference/is_diatonic.html @@ -1,9 +1,9 @@ -Check if notes and chords are diatonic — is_diatonic • tabrCheck if notes and chords are diatonic — is_diatonic • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,19 +148,19 @@

    Check if notes and chords are diatonic

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string.

    -
    key
    +
    key

    character, key signature.

    Value

    - - -

    logical

    +

    logical

    Details

    @@ -192,15 +192,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/is_in_scale.html b/docs/reference/is_in_scale.html new file mode 100644 index 0000000..a9b1576 --- /dev/null +++ b/docs/reference/is_in_scale.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/is_lyrics.html b/docs/reference/is_lyrics.html new file mode 100644 index 0000000..ecce48d --- /dev/null +++ b/docs/reference/is_lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/is_mode.html b/docs/reference/is_mode.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/is_mode.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/is_music.html b/docs/reference/is_music.html new file mode 100644 index 0000000..9afc2a8 --- /dev/null +++ b/docs/reference/is_music.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/is_note.html b/docs/reference/is_note.html new file mode 100644 index 0000000..3d34843 --- /dev/null +++ b/docs/reference/is_note.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/is_noteinfo.html b/docs/reference/is_noteinfo.html new file mode 100644 index 0000000..ecb90c9 --- /dev/null +++ b/docs/reference/is_noteinfo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/is_noteworthy.html b/docs/reference/is_noteworthy.html new file mode 100644 index 0000000..3d34843 --- /dev/null +++ b/docs/reference/is_noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/is_space_time.html b/docs/reference/is_space_time.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/is_space_time.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/is_vector_time.html b/docs/reference/is_vector_time.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/is_vector_time.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/key_is_flat.html b/docs/reference/key_is_flat.html new file mode 100644 index 0000000..f03b70d --- /dev/null +++ b/docs/reference/key_is_flat.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/key_is_major.html b/docs/reference/key_is_major.html new file mode 100644 index 0000000..f03b70d --- /dev/null +++ b/docs/reference/key_is_major.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/key_is_minor.html b/docs/reference/key_is_minor.html new file mode 100644 index 0000000..f03b70d --- /dev/null +++ b/docs/reference/key_is_minor.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/key_is_natural.html b/docs/reference/key_is_natural.html new file mode 100644 index 0000000..f03b70d --- /dev/null +++ b/docs/reference/key_is_natural.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/key_is_sharp.html b/docs/reference/key_is_sharp.html new file mode 100644 index 0000000..f03b70d --- /dev/null +++ b/docs/reference/key_is_sharp.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/key_n_flats.html b/docs/reference/key_n_flats.html new file mode 100644 index 0000000..f03b70d --- /dev/null +++ b/docs/reference/key_n_flats.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/key_n_sharps.html b/docs/reference/key_n_sharps.html new file mode 100644 index 0000000..f03b70d --- /dev/null +++ b/docs/reference/key_n_sharps.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/keys.html b/docs/reference/keys.html index 85ff7da..b9eeeff 100644 --- a/docs/reference/keys.html +++ b/docs/reference/keys.html @@ -1,9 +1,9 @@ -Key signatures — keys • tabrKey signatures — keys • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -162,19 +162,19 @@

    Key signatures

    Arguments

    -
    type
    + + +
    type

    character, defaults to "all".

    -
    key
    +
    key

    character, key signature.

    Value

    - - -

    character vector.

    +

    character vector.

    Details

    @@ -218,15 +218,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/length.lyrics.html b/docs/reference/length.lyrics.html new file mode 100644 index 0000000..da6e983 --- /dev/null +++ b/docs/reference/length.lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/length.music.html b/docs/reference/length.music.html new file mode 100644 index 0000000..da6e983 --- /dev/null +++ b/docs/reference/length.music.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/length.noteinfo.html b/docs/reference/length.noteinfo.html new file mode 100644 index 0000000..da6e983 --- /dev/null +++ b/docs/reference/length.noteinfo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/length.noteworthy.html b/docs/reference/length.noteworthy.html new file mode 100644 index 0000000..da6e983 --- /dev/null +++ b/docs/reference/length.noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/lilypond.html b/docs/reference/lilypond.html index 4b81c6f..a6f8f46 100644 --- a/docs/reference/lilypond.html +++ b/docs/reference/lilypond.html @@ -1,10 +1,10 @@ -Save score to LilyPond file — lilypond • tabrSave score to LilyPond file — lilypond • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -164,72 +164,72 @@

    Save score to LilyPond file

    Arguments

    -
    score
    + + +
    score

    a score object.

    -
    file
    +
    file

    character, LilyPond output file ending in .ly. May include an absolute or relative path.

    -
    key
    +
    key

    character, key signature, e.g., c, b_, f#m, etc.

    -
    time
    +
    time

    character, defaults to "4/4".

    -
    tempo
    +
    tempo

    character, defaults to "2 = 60". Set to NA or NULL to suppress metronome mark in output. If suppressed and midi = TRUE, an error is thrown.

    -
    header
    +
    header

    a named list of arguments passed to the header of the LilyPond file. See details.

    -
    paper
    +
    paper

    a named list of arguments for the LilyPond file page layout. See details.

    -
    string_names
    +
    string_names

    label strings at beginning of tab staff. NULL (default) for non-standard tunings only, TRUE or FALSE for force on or off completely.

    -
    endbar
    +
    endbar

    character, the global end bar.

    -
    midi
    +
    midi

    logical, add midi inclusion specification to LilyPond file.

    -
    colors
    +
    colors

    a named list of LilyPond element color overrides. See details.

    -
    crop_png
    +
    crop_png

    logical, alter template for cropped height. See details.

    -
    simplify
    +
    simplify

    logical, uses simplify_phrase() to convert to simpler, more efficient LilyPond syntax.

    Value

    - - -

    nothing returned; a file is written.

    +

    nothing returned; a file is written.

    Details

    @@ -242,7 +242,7 @@

    Details

    Header options

    - +

    All header list elements are character strings. The options for header include the following.

    • title

      • @@ -260,7 +260,7 @@

      Header options

    Paper options

    - +

    All paper list elements are numeric except page_numbers and print_first_page_number, which are logical. page_numbers = FALSE @@ -280,7 +280,7 @@

    Paper options

    Color options

    - +

    You can provide a named list of global color overrides for various sheet music elements with the colors argument of lilypond or one of the @@ -354,15 +354,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/lilypond_root.html b/docs/reference/lilypond_root.html index 0196476..17128cd 100644 --- a/docs/reference/lilypond_root.html +++ b/docs/reference/lilypond_root.html @@ -1,9 +1,9 @@ -LilyPond installation information — lilypond_root • tabrLilyPond installation information — lilypond_root • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -152,9 +152,7 @@

    LilyPond installation information

    Value

    - - -

    a message or system standard output.

    +

    a message or system standard output.

    Details

    @@ -169,7 +167,7 @@

    Examples

    #> C:/Program Files (x86)/LilyPond/usr/bin/lilypond.exe lilypond_version() tabr_lilypond_api() -#> The tabr 0.5.0 LilyPond API was built and tested against LilyPond 2.23.6 on Windows. +#> The tabr 0.5.1 LilyPond API was built and tested against LilyPond 2.23.6 on Windows.
    @@ -184,15 +182,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/lilypond_version.html b/docs/reference/lilypond_version.html new file mode 100644 index 0000000..affe160 --- /dev/null +++ b/docs/reference/lilypond_version.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/lp_chord_id.html b/docs/reference/lp_chord_id.html index 181a3e2..f68c26c 100644 --- a/docs/reference/lp_chord_id.html +++ b/docs/reference/lp_chord_id.html @@ -1,9 +1,9 @@ -LilyPond chord notation — lp_chord_id • tabrLilyPond chord notation — lp_chord_id • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -150,27 +150,27 @@

    LilyPond chord notation

    Arguments

    -
    root
    + + +
    root

    character, root note.

    -
    chord
    +
    chord

    character, tabr format chord name.

    -
    exact
    +
    exact

    logical, return a more exact LilyPond chord representation.

    -
    ...
    +
    ...

    additional arguments passed to transpose().

    Value

    - - -

    character

    +

    character

    Details

    @@ -208,15 +208,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/lp_chord_mod.html b/docs/reference/lp_chord_mod.html new file mode 100644 index 0000000..37545ae --- /dev/null +++ b/docs/reference/lp_chord_mod.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/lyrical.html b/docs/reference/lyrical.html new file mode 100644 index 0000000..ecce48d --- /dev/null +++ b/docs/reference/lyrical.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/lyrics.html b/docs/reference/lyrics.html index 6e9ec98..c23b121 100644 --- a/docs/reference/lyrics.html +++ b/docs/reference/lyrics.html @@ -1,9 +1,9 @@ -Create lyrics and check lyrics string validity — lyrics • tabrCreate lyrics and check lyrics string validity — lyrics • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -154,22 +154,22 @@

    Create lyrics and check lyrics string validity

    Arguments

    -
    x
    + + +
    x

    character or lyrics object. For lyrics_template(), an integer or one of the classes noteworthy, noteinfo or music to derive the number of timesteps from.

    -
    format
    +
    format

    NULL or character, the timestep delimiter format, "space" or "vector".

    Value

    - - -

    depends on the function

    +

    depends on the function

    Details

    @@ -258,15 +258,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/lyrics_template.html b/docs/reference/lyrics_template.html new file mode 100644 index 0000000..ecce48d --- /dev/null +++ b/docs/reference/lyrics_template.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/mainIntervals.html b/docs/reference/mainIntervals.html index d551f9c..143b501 100644 --- a/docs/reference/mainIntervals.html +++ b/docs/reference/mainIntervals.html @@ -1,10 +1,10 @@ -Main musical intervals — mainIntervals • tabrMain musical intervals — mainIntervals • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -165,15 +165,15 @@

    Format

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/midi_key.html b/docs/reference/midi_key.html new file mode 100644 index 0000000..12a353e --- /dev/null +++ b/docs/reference/midi_key.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/midi_metadata.html b/docs/reference/midi_metadata.html new file mode 100644 index 0000000..12a353e --- /dev/null +++ b/docs/reference/midi_metadata.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/midi_notes.html b/docs/reference/midi_notes.html new file mode 100644 index 0000000..12a353e --- /dev/null +++ b/docs/reference/midi_notes.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/midi_time.html b/docs/reference/midi_time.html new file mode 100644 index 0000000..12a353e --- /dev/null +++ b/docs/reference/midi_time.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/midily.html b/docs/reference/midily.html index e65a1f0..ff21f27 100644 --- a/docs/reference/midily.html +++ b/docs/reference/midily.html @@ -1,9 +1,9 @@ -Convert MIDI to LilyPond file — midily • tabrConvert MIDI to LilyPond file — midily • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -159,53 +159,53 @@

    Convert MIDI to LilyPond file

    Arguments

    -
    midi_file
    + + +
    midi_file

    character, MIDI file (.mid). May include an absolute or relative path.

    -
    file
    +
    file

    LilyPond output file ending in .ly.

    -
    key
    +
    key

    key signature, defaults to "c".

    -
    absolute
    +
    absolute

    logical, print absolute pitches (unavailable in current package version).

    -
    quantize
    +
    quantize

    integer, duration, quantize notes on duration.

    -
    explicit
    +
    explicit

    logical, print explicit durations.

    -
    start_quant
    +
    start_quant

    integer, duration, quantize note starts on the duration.

    -
    allow_tuplet
    +
    allow_tuplet

    character vector, allow tuplet durations. See details.

    -
    details
    +
    details

    logical, print additional information to console.

    -
    lyric
    +
    lyric

    logical, treat all text as lyrics.

    Value

    - - -

    nothing returned; a file is written.

    +

    nothing returned; a file is written.

    Details

    @@ -237,13 +237,13 @@

    See also

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 if(tabr_options()$midi2ly != ""){
   midi <- system.file("example.mid", package = "tabr")
   outfile <- file.path(tempdir(), "out.ly")
   midily(midi, outfile) # requires LilyPond installation
 }
-}
+} # }
    @@ -258,15 +258,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/miditab.html b/docs/reference/miditab.html index 62ce942..e008fd7 100644 --- a/docs/reference/miditab.html +++ b/docs/reference/miditab.html @@ -1,9 +1,9 @@ -Convert MIDI to tablature — miditab • tabrConvert MIDI to tablature — miditab • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,33 +148,33 @@

    Convert MIDI to tablature

    Arguments

    -
    midi_file
    + + +
    midi_file

    character, MIDI file (.mid). May include an absolute or relative path.

    -
    file
    +
    file

    character, output file ending in .pdf or .png.

    -
    keep_ly
    +
    keep_ly

    logical, keep LilyPond file.

    -
    details
    +
    details

    logical, set to TRUE to print LilyPond log output to console. Windows only.

    -
    ...
    +
    ...

    additional arguments passed to midily().

    Value

    - - -

    nothing returned; a file is written.

    +

    nothing returned; a file is written.

    Details

    @@ -202,13 +202,13 @@

    See also

    Examples

    - 
    if (FALSE) {
+    
    if (FALSE) { # \dontrun{
 if(tabr_options()$midi2ly != ""){
   midi <- system.file("example.mid", package = "tabr")
   outfile <- file.path(tempdir(), "out.pdf")
   miditab(midi, outfile, details = FALSE) # requires LilyPond installation
 }
-}
+} # }
    @@ -223,15 +223,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/mode-helpers.html b/docs/reference/mode-helpers.html index 205afb7..6db982b 100644 --- a/docs/reference/mode-helpers.html +++ b/docs/reference/mode-helpers.html @@ -1,9 +1,9 @@ -Mode helpers — mode-helpers • tabrMode helpers — mode-helpers • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -173,38 +173,38 @@

    Mode helpers

    Arguments

    -
    mode
    + + +
    mode

    character, which mode.

    -
    notes
    +
    notes

    character, for mode, may be a noteworthy string of seven notes, space- or vector-delimited.

    -
    ignore_octave
    +
    ignore_octave

    logical, strip octave numbering from modes not rooted on C.

    -
    n
    +
    n

    integer, degree of rotation.

    -
    key
    +
    key

    character, key signature.

    -
    collapse
    +
    collapse

    logical, collapse result into a single string ready for phrase construction.

    Value

    - - -

    character

    +

    character

    Details

    @@ -270,15 +270,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/mode_aeolian.html b/docs/reference/mode_aeolian.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/mode_aeolian.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/mode_dorian.html b/docs/reference/mode_dorian.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/mode_dorian.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/mode_ionian.html b/docs/reference/mode_ionian.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/mode_ionian.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/mode_locrian.html b/docs/reference/mode_locrian.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/mode_locrian.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/mode_lydian.html b/docs/reference/mode_lydian.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/mode_lydian.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/mode_mixolydian.html b/docs/reference/mode_mixolydian.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/mode_mixolydian.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/mode_modern.html b/docs/reference/mode_modern.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/mode_modern.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/mode_phrygian.html b/docs/reference/mode_phrygian.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/mode_phrygian.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/mode_rotate.html b/docs/reference/mode_rotate.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/mode_rotate.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/modes.html b/docs/reference/modes.html new file mode 100644 index 0000000..6427497 --- /dev/null +++ b/docs/reference/modes.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/music-helpers.html b/docs/reference/music-helpers.html index 5a5419c..df49f3d 100644 --- a/docs/reference/music-helpers.html +++ b/docs/reference/music-helpers.html @@ -1,9 +1,9 @@ -Accessing music object values and attributes — music-helpers • tabrAccessing music object values and attributes — music-helpers • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -160,15 +160,15 @@

    Accessing music object values and attributes

    Arguments

    -
    x
    + + +
    x

    music object.

    Value

    - - -

    depends on the function

    +

    depends on the function

    Details

    @@ -303,15 +303,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/music.html b/docs/reference/music.html index 9a91c79..cd0fcc0 100644 --- a/docs/reference/music.html +++ b/docs/reference/music.html @@ -1,11 +1,11 @@ -Create music objects and check music string validity — music • tabrCreate music objects and check music string validity — music • tabr - +
    @@ -27,14 +27,14 @@
    - +
    @@ -169,60 +169,60 @@

    Create music objects and check music string validity

    Arguments

    -
    x
    + + +
    x

    character or music, a string to be coerced or an existing music object.

    -
    notes, info
    +
    notes, info

    noteworthy and note info strings. For as_music(), a complete music string is assumed for notes when info = NULL.

    -
    lyrics
    +
    lyrics

    optional lyrics object or NA, attached to output as an attribute.

    -
    key
    +
    key

    character, store the key signature as a music attribute. Defaults to "c". See details.

    -
    time
    +
    time

    character, store the time signature as a music attribute. Defaults to "4/4". See details.

    -
    tempo
    +
    tempo

    character or NA, defaults to "2 = 60". See details.

    -
    accidentals
    +
    accidentals

    NULL or character, represent accidentals, "flat" or "sharp".

    -
    format
    +
    format

    NULL or character, the timestep delimiter format, "space" or "vector".

    -
    labels
    +
    labels

    character, text annotations to attach to timesteps using notate.

    -
    at
    +
    at

    integer, timesteps for labels, defaults to starting from time one.

    Value

    - - -

    depends on the function

    +

    depends on the function

    Details

    @@ -326,15 +326,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/music_info.html b/docs/reference/music_info.html new file mode 100644 index 0000000..7d9bf7b --- /dev/null +++ b/docs/reference/music_info.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/music_key.html b/docs/reference/music_key.html new file mode 100644 index 0000000..7d9bf7b --- /dev/null +++ b/docs/reference/music_key.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/music_lyrics.html b/docs/reference/music_lyrics.html new file mode 100644 index 0000000..7d9bf7b --- /dev/null +++ b/docs/reference/music_lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/music_notes.html b/docs/reference/music_notes.html new file mode 100644 index 0000000..7d9bf7b --- /dev/null +++ b/docs/reference/music_notes.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/music_split.html b/docs/reference/music_split.html new file mode 100644 index 0000000..9afc2a8 --- /dev/null +++ b/docs/reference/music_split.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/music_strings.html b/docs/reference/music_strings.html new file mode 100644 index 0000000..7d9bf7b --- /dev/null +++ b/docs/reference/music_strings.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/music_tempo.html b/docs/reference/music_tempo.html new file mode 100644 index 0000000..7d9bf7b --- /dev/null +++ b/docs/reference/music_tempo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/music_time.html b/docs/reference/music_time.html new file mode 100644 index 0000000..7d9bf7b --- /dev/null +++ b/docs/reference/music_time.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/musical.html b/docs/reference/musical.html new file mode 100644 index 0000000..9afc2a8 --- /dev/null +++ b/docs/reference/musical.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/n_beats.html b/docs/reference/n_beats.html new file mode 100644 index 0000000..9d517ac --- /dev/null +++ b/docs/reference/n_beats.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/n_chords.html b/docs/reference/n_chords.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/n_chords.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/n_measures.html b/docs/reference/n_measures.html index b6a3d7a..f6c391a 100644 --- a/docs/reference/n_measures.html +++ b/docs/reference/n_measures.html @@ -1,9 +1,9 @@ -Summarize rhythm and time of music objects — n_measures • tabrSummarize rhythm and time of music objects — n_measures • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -162,24 +162,24 @@

    Summarize rhythm and time of music objects

    Arguments

    -
    x
    + + +
    x

    note info or music object.

    -
    unit
    +
    unit

    character, or an equivalent integer. A beat unit. See details.

    -
    tempo
    +
    tempo

    character, LilyPond format tempo, e.g., "4 = 120" is 120 quarter note beats per minute.

    Value

    - - -

    depends on function

    +

    depends on function

    Details

    @@ -267,15 +267,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/n_notes.html b/docs/reference/n_notes.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/n_notes.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/n_octaves.html b/docs/reference/n_octaves.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/n_octaves.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/n_steps.html b/docs/reference/n_steps.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/n_steps.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/naturalize.html b/docs/reference/naturalize.html new file mode 100644 index 0000000..3899d17 --- /dev/null +++ b/docs/reference/naturalize.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/notable.html b/docs/reference/notable.html new file mode 100644 index 0000000..f75d458 --- /dev/null +++ b/docs/reference/notable.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/notate.html b/docs/reference/notate.html index cc0d4c5..74e6255 100644 --- a/docs/reference/notate.html +++ b/docs/reference/notate.html @@ -1,10 +1,10 @@ -Add text to music staff — notate • tabrAdd text to music staff — notate • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -150,23 +150,23 @@

    Add text to music staff

    Arguments

    -
    x
    + + +
    x

    character.

    -
    text
    +
    text

    character.

    -
    position
    +
    position

    character, top or bottom.

    Value

    - - -

    a character string.

    +

    a character string.

    Details

    @@ -198,15 +198,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/note-checks.html b/docs/reference/note-checks.html index d0c2160..0a1e6f0 100644 --- a/docs/reference/note-checks.html +++ b/docs/reference/note-checks.html @@ -1,10 +1,10 @@ -Basic noteworthy string checks — note-checks • tabrBasic noteworthy string checks — note-checks • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -164,15 +164,15 @@

    Basic noteworthy string checks

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string.

    Value

    - - -

    logical

    +

    logical

    Details

    @@ -237,15 +237,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/note-coerce.html b/docs/reference/note-coerce.html index a3476b8..9e62074 100644 --- a/docs/reference/note-coerce.html +++ b/docs/reference/note-coerce.html @@ -1,11 +1,11 @@ -Basic noteworthy strings formatting and coercion helpers — note-coerce • tabrBasic noteworthy strings formatting and coercion helpers — note-coerce • tabr - +
    @@ -27,14 +27,14 @@
    - +
    @@ -168,34 +168,34 @@

    Basic noteworthy strings formatting and coercion helpers

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string, space-delimited or vector of individual entries.

    -
    type
    +
    type

    character, type of note to naturalize.

    -
    key
    +
    key

    character, key signature to coerce any accidentals to the appropriate form for the key. May also specify "sharp" or "flat".

    -
    x
    +
    x

    for generic functions: notes, info or music string.

    -
    ignore_octave
    +
    ignore_octave

    logical, strip any octave notation that may be present, returning only the basic notes without explicit pitch.

    Value

    - - -

    character

    +

    character

    Details

    @@ -214,7 +214,7 @@

    Details

    A note on generic functions

    - +

    as_space_time() and as_vector_time() are generic since they apply clearly to and are useful for not only noteworthy strings, but also note info and @@ -295,15 +295,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/note-equivalence.html b/docs/reference/note-equivalence.html index 356fdcb..5423024 100644 --- a/docs/reference/note-equivalence.html +++ b/docs/reference/note-equivalence.html @@ -1,10 +1,10 @@ -Note, pitch and chord equivalence — note-equivalence • tabrNote, pitch and chord equivalence — note-equivalence • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -160,31 +160,31 @@

    Note, pitch and chord equivalence

    Arguments

    -
    notes1
    + + +
    notes1

    character, noteworthy string, space-delimited or vector of individual entries.

    -
    notes2
    +
    notes2

    character, noteworthy string, space-delimited or vector of individual entries.

    -
    ignore_octave
    +
    ignore_octave

    logical, ignore octave position when considering equivalence.

    -
    single_octave
    +
    single_octave

    logical, for octave equality, require all notes share the same octave. See details.

    Value

    - - -

    logical

    +

    logical

    Details

    @@ -279,15 +279,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/note-logic.html b/docs/reference/note-logic.html index bdaccc6..85c9f75 100644 --- a/docs/reference/note-logic.html +++ b/docs/reference/note-logic.html @@ -1,9 +1,9 @@ -Relational operators for noteworthy class — note-logic • tabrRelational operators for noteworthy class — note-logic • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -143,40 +143,40 @@

    Relational operators for noteworthy class

    - 
    # S3 method for noteworthy
-==(e1, e2)
-
-# S3 method for noteworthy
-!=(e1, e2)
-
-# S3 method for noteworthy
-&lt;(e1, e2)
-
-# S3 method for noteworthy
-&lt;=(e1, e2)
-
-# S3 method for noteworthy
-&gt;(e1, e2)
-
-# S3 method for noteworthy
-&gt;=(e1, e2)
    + 
    # S3 method for class 'noteworthy'
+e1 == e2
+
+# S3 method for class 'noteworthy'
+e1 != e2
+
+# S3 method for class 'noteworthy'
+e1 < e2
+
+# S3 method for class 'noteworthy'
+e1 <= e2
+
+# S3 method for class 'noteworthy'
+e1 > e2
+
+# S3 method for class 'noteworthy'
+e1 >= e2

    Arguments

    -
    e1
    + + +
    e1

    noteworthy string.

    -
    e2
    +
    e2

    noteworthy string.

    Value

    - - -

    logical vector

    +

    logical vector

    Details

    @@ -224,15 +224,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/note-metadata.html b/docs/reference/note-metadata.html index 7dd560b..6fe3c0d 100644 --- a/docs/reference/note-metadata.html +++ b/docs/reference/note-metadata.html @@ -1,9 +1,9 @@ -Noteworthy string metadata — note-metadata • tabrNoteworthy string metadata — note-metadata • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -178,20 +178,20 @@

    Noteworthy string metadata

    Arguments

    -
    x
    + + +
    x

    for generic functions: notes, info or music string.

    -
    notes
    +
    notes

    character, a noteworthy string, space-delimited or vector of individual entries.

    Value

    - - -

    varies by function

    +

    varies by function

    Details

    @@ -209,7 +209,7 @@

    Details

    A note on generic functions

    - +

    n_steps() and the three time format functions are generic since they apply clearly to and are useful for not only noteworthy strings, but also @@ -285,15 +285,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/note-summaries.html b/docs/reference/note-summaries.html index 46b5e4f..f3c8106 100644 --- a/docs/reference/note-summaries.html +++ b/docs/reference/note-summaries.html @@ -1,9 +1,9 @@ -Noteworthy string summaries — note-summaries • tabrNoteworthy string summaries — note-summaries • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -170,20 +170,20 @@

    Noteworthy string summaries

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string, space-delimited or vector of individual entries.

    -
    rests
    +
    rests

    logical, include rests r and silent rests s in tally.

    Value

    - - -

    varies by function

    +

    varies by function

    Details

    @@ -282,15 +282,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/note_arpeggiate.html b/docs/reference/note_arpeggiate.html new file mode 100644 index 0000000..f841eb7 --- /dev/null +++ b/docs/reference/note_arpeggiate.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_has_accidental.html b/docs/reference/note_has_accidental.html new file mode 100644 index 0000000..5320d2f --- /dev/null +++ b/docs/reference/note_has_accidental.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_has_flat.html b/docs/reference/note_has_flat.html new file mode 100644 index 0000000..5320d2f --- /dev/null +++ b/docs/reference/note_has_flat.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_has_integer.html b/docs/reference/note_has_integer.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/note_has_integer.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_has_natural.html b/docs/reference/note_has_natural.html new file mode 100644 index 0000000..5320d2f --- /dev/null +++ b/docs/reference/note_has_natural.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_has_rest.html b/docs/reference/note_has_rest.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/note_has_rest.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_has_sharp.html b/docs/reference/note_has_sharp.html new file mode 100644 index 0000000..5320d2f --- /dev/null +++ b/docs/reference/note_has_sharp.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_has_tick.html b/docs/reference/note_has_tick.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/note_has_tick.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_in_scale.html b/docs/reference/note_in_scale.html new file mode 100644 index 0000000..a9b1576 --- /dev/null +++ b/docs/reference/note_in_scale.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_is_accidental.html b/docs/reference/note_is_accidental.html new file mode 100644 index 0000000..5320d2f --- /dev/null +++ b/docs/reference/note_is_accidental.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_is_equal.html b/docs/reference/note_is_equal.html new file mode 100644 index 0000000..c3c5eb7 --- /dev/null +++ b/docs/reference/note_is_equal.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_is_flat.html b/docs/reference/note_is_flat.html new file mode 100644 index 0000000..5320d2f --- /dev/null +++ b/docs/reference/note_is_flat.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_is_identical.html b/docs/reference/note_is_identical.html new file mode 100644 index 0000000..c3c5eb7 --- /dev/null +++ b/docs/reference/note_is_identical.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_is_integer.html b/docs/reference/note_is_integer.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/note_is_integer.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_is_natural.html b/docs/reference/note_is_natural.html new file mode 100644 index 0000000..5320d2f --- /dev/null +++ b/docs/reference/note_is_natural.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_is_rest.html b/docs/reference/note_is_rest.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/note_is_rest.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_is_sharp.html b/docs/reference/note_is_sharp.html new file mode 100644 index 0000000..5320d2f --- /dev/null +++ b/docs/reference/note_is_sharp.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_is_tick.html b/docs/reference/note_is_tick.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/note_is_tick.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_ngram.html b/docs/reference/note_ngram.html index 99f425b..736ed7a 100644 --- a/docs/reference/note_ngram.html +++ b/docs/reference/note_ngram.html @@ -1,9 +1,9 @@ -Note/chord n-gram — note_ngram • tabrNote/chord n-gram — note_ngram • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,28 +148,28 @@

    Note/chord n-gram

    Arguments

    -
    notes
    + + +
    notes

    a noteworthy string.

    -
    n
    +
    n

    Number of grams. Must be >= 1 and <= number of timesteps in notes.

    -
    tally
    +
    tally

    logical, tally n-grams in a data frame. Otherwise a list.

    -
    rests
    +
    rests

    logical, exclude rests. Affects the number of timesteps.

    Value

    - - -

    list of noteworthy objects or a tibble

    +

    list of noteworthy objects or a tibble

    @@ -232,15 +232,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/note_rotate.html b/docs/reference/note_rotate.html new file mode 100644 index 0000000..f841eb7 --- /dev/null +++ b/docs/reference/note_rotate.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_set_key.html b/docs/reference/note_set_key.html new file mode 100644 index 0000000..3899d17 --- /dev/null +++ b/docs/reference/note_set_key.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_shift.html b/docs/reference/note_shift.html new file mode 100644 index 0000000..f841eb7 --- /dev/null +++ b/docs/reference/note_shift.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/note_slice.html b/docs/reference/note_slice.html index 48e4ab4..2405d72 100644 --- a/docs/reference/note_slice.html +++ b/docs/reference/note_slice.html @@ -1,9 +1,9 @@ -Slice, sort, rotate, shift and arpeggiate notes — note_slice • tabrSlice, sort, rotate, shift and arpeggiate notes — note_slice • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -156,25 +156,27 @@

    Slice, sort, rotate, shift and arpeggiate notes

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string, space-delimited or vector of individual entries.

    -
    ...
    +
    ...

    For note_slice(), an integer or logical vector.

    -
    decreasing
    +
    decreasing

    logical, short in decreasing order.

    -
    n
    +
    n

    integer, number of rotations or extensions of note sequence. See details.

    -
    step
    +
    step

    integer, number of semitone steps from the first (or last) note in notes at which to begin repeating the shifted notes sequence as an arpeggio. See examples.

    @@ -182,9 +184,7 @@

    Arguments

    Value

    - - -

    character

    +

    character

    Details

    @@ -276,15 +276,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/note_sort.html b/docs/reference/note_sort.html new file mode 100644 index 0000000..f841eb7 --- /dev/null +++ b/docs/reference/note_sort.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/noteinfo.html b/docs/reference/noteinfo.html index 9a1cc1b..8a5f991 100644 --- a/docs/reference/noteinfo.html +++ b/docs/reference/noteinfo.html @@ -1,9 +1,9 @@ -Note info helpers — noteinfo • tabrNote info helpers — noteinfo • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -166,16 +166,16 @@

    Note info helpers

    Arguments

    -
    x
    + + +
    x

    character, note info string normally accompanying a noteworthy string for building phrase objects. x may also be a phrase object.

    Value

    - - -

    character

    +

    character

    Details

    @@ -260,15 +260,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/noteworthy.html b/docs/reference/noteworthy.html new file mode 100644 index 0000000..3d34843 --- /dev/null +++ b/docs/reference/noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/notify.html b/docs/reference/notify.html new file mode 100644 index 0000000..f75d458 --- /dev/null +++ b/docs/reference/notify.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/octave_is_equal.html b/docs/reference/octave_is_equal.html new file mode 100644 index 0000000..c3c5eb7 --- /dev/null +++ b/docs/reference/octave_is_equal.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/octave_is_identical.html b/docs/reference/octave_is_identical.html new file mode 100644 index 0000000..c3c5eb7 --- /dev/null +++ b/docs/reference/octave_is_identical.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/octave_range.html b/docs/reference/octave_range.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/octave_range.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/octave_span.html b/docs/reference/octave_span.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/octave_span.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/octave_type.html b/docs/reference/octave_type.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/octave_type.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/octaves.html b/docs/reference/octaves.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/octaves.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/p.html b/docs/reference/p.html new file mode 100644 index 0000000..195c94f --- /dev/null +++ b/docs/reference/p.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pc.html b/docs/reference/pc.html new file mode 100644 index 0000000..0f85664 --- /dev/null +++ b/docs/reference/pc.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pct.html b/docs/reference/pct.html new file mode 100644 index 0000000..f2df233 --- /dev/null +++ b/docs/reference/pct.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/phrase-checks.html b/docs/reference/phrase-checks.html index 757e810..25743c5 100644 --- a/docs/reference/phrase-checks.html +++ b/docs/reference/phrase-checks.html @@ -1,10 +1,10 @@ -Phrase validation and coercion — phrase-checks • tabrPhrase validation and coercion — phrase-checks • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -162,25 +162,25 @@

    Phrase validation and coercion

    Arguments

    -
    phrase
    + + +
    phrase

    phrase object or character string (candidate phrase).

    -
    collapse
    +
    collapse

    logical, collapse result into a single string ready for phrase construction.

    -
    annotations
    +
    annotations

    logical, strip any text annotations from the note info converted from phrase().

    Value

    - - -

    see details for each function's purpose and return value.

    +

    see details for each function's purpose and return value.

    Details

    @@ -290,15 +290,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/phrase.html b/docs/reference/phrase.html index 52f67c5..9323aca 100644 --- a/docs/reference/phrase.html +++ b/docs/reference/phrase.html @@ -1,11 +1,11 @@ -Create a musical phrase — phrase • tabrCreate a musical phrase — phrase • tabr - +
    @@ -27,14 +27,14 @@
    - +
    @@ -154,19 +154,21 @@

    Create a musical phrase

    Arguments

    -
    notes, info
    + + +
    notes, info

    noteworthy and note info strings. When info = NULL, it is assumed that notes refers to a music object or string formatted as such.

    -
    string
    +
    string

    space-delimited character string or vector (or integer vector if simple string numbers). This is an optional argument that specifies which instrument strings to play for each specific timestep. Otherwise NULL.

    -
    bar
    +
    bar

    character or NULL (default). Terminates the phrase with a bar or bar check. See details. Also see the LilyPond help documentation on bar notation for all the valid options.

    @@ -174,9 +176,7 @@

    Arguments

    Value

    - - -

    a phrase.

    +

    a phrase.

    Details

    @@ -264,15 +264,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/phrase_info.html b/docs/reference/phrase_info.html new file mode 100644 index 0000000..f75d458 --- /dev/null +++ b/docs/reference/phrase_info.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/phrase_notes.html b/docs/reference/phrase_notes.html new file mode 100644 index 0000000..f75d458 --- /dev/null +++ b/docs/reference/phrase_notes.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/phrase_strings.html b/docs/reference/phrase_strings.html new file mode 100644 index 0000000..f75d458 --- /dev/null +++ b/docs/reference/phrase_strings.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/phrasey.html b/docs/reference/phrasey.html new file mode 100644 index 0000000..f75d458 --- /dev/null +++ b/docs/reference/phrasey.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pitch_diff.html b/docs/reference/pitch_diff.html new file mode 100644 index 0000000..34c1ad5 --- /dev/null +++ b/docs/reference/pitch_diff.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pitch_freq.html b/docs/reference/pitch_freq.html index 81bf210..f064d29 100644 --- a/docs/reference/pitch_freq.html +++ b/docs/reference/pitch_freq.html @@ -1,9 +1,9 @@ -Pitch conversions — pitch_freq • tabrPitch conversions — pitch_freq • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -173,43 +173,43 @@

    Pitch conversions

    Arguments

    -
    notes
    + + +
    notes

    character, noteworthy string, space-delimited or vector of individual entries. See details.

    -
    a4
    +
    a4

    the fixed frequency of the A above middle C, typically 440 Hz.

    -
    freq
    +
    freq

    numeric vector, frequencies in Hz.

    -
    octaves
    +
    octaves

    NULL or character, "tick" or "integer" octave numbering in result.

    -
    accidentals
    +
    accidentals

    NULL or character, represent accidentals, "flat" or "sharp".

    -
    collapse
    +
    collapse

    logical, collapse result into a single string. key and style.

    -
    semitones
    +
    semitones

    integer values of pitches.

    Value

    - - -

    integer, numeric or noteworthy vector

    +

    integer, numeric or noteworthy vector

    Details

    @@ -277,15 +277,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/pitch_interval.html b/docs/reference/pitch_interval.html new file mode 100644 index 0000000..34c1ad5 --- /dev/null +++ b/docs/reference/pitch_interval.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pitch_is_equal.html b/docs/reference/pitch_is_equal.html new file mode 100644 index 0000000..c3c5eb7 --- /dev/null +++ b/docs/reference/pitch_is_equal.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pitch_is_identical.html b/docs/reference/pitch_is_identical.html new file mode 100644 index 0000000..c3c5eb7 --- /dev/null +++ b/docs/reference/pitch_is_identical.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pitch_range.html b/docs/reference/pitch_range.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/pitch_range.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pitch_semitones.html b/docs/reference/pitch_semitones.html new file mode 100644 index 0000000..f7c6798 --- /dev/null +++ b/docs/reference/pitch_semitones.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pitch_seq.html b/docs/reference/pitch_seq.html index 23a34d8..7f1eb44 100644 --- a/docs/reference/pitch_seq.html +++ b/docs/reference/pitch_seq.html @@ -1,9 +1,9 @@ -Create a sequence from pitch notation — pitch_seq • tabrCreate a sequence from pitch notation — pitch_seq • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,36 +148,36 @@

    Create a sequence from pitch notation

    Arguments

    -
    x
    + + +
    x

    character, valid pitch notation, e.g., "a2" or "a,".

    -
    y
    +
    y

    character, same as x for the sequence x:y. If a number, the length of the sequence from x and the sign of y determines the direction.

    -
    key
    +
    key

    character, key signature for a diatonic sequence. key = NULL (default) results in a chromatic sequence.

    -
    scale
    +
    scale

    character, if you want to use a different scale in conjunction with the key/root note, you can provide it, e.g., scale = "harmonic minor". Ignored if key = NULL.

    -
    format
    +
    format

    character, the timestep delimiter format, "space" or "vector".

    Value

    - - -

    noteworthy

    +

    noteworthy

    Details

    @@ -240,15 +240,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/plot_chord.html b/docs/reference/plot_chord.html new file mode 100644 index 0000000..0618956 --- /dev/null +++ b/docs/reference/plot_chord.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/plot_fretboard-1.png b/docs/reference/plot_fretboard-1.png index a9735a6..b04d919 100644 Binary files a/docs/reference/plot_fretboard-1.png and b/docs/reference/plot_fretboard-1.png differ diff --git a/docs/reference/plot_fretboard-2.png b/docs/reference/plot_fretboard-2.png index fbe6853..acd6f37 100644 Binary files a/docs/reference/plot_fretboard-2.png and b/docs/reference/plot_fretboard-2.png differ diff --git a/docs/reference/plot_fretboard-3.png b/docs/reference/plot_fretboard-3.png index 7b342f1..bdb95e1 100644 Binary files a/docs/reference/plot_fretboard-3.png and b/docs/reference/plot_fretboard-3.png differ diff --git a/docs/reference/plot_fretboard-5.png b/docs/reference/plot_fretboard-5.png index 074f228..d800a1e 100644 Binary files a/docs/reference/plot_fretboard-5.png and b/docs/reference/plot_fretboard-5.png differ diff --git a/docs/reference/plot_fretboard-6.png b/docs/reference/plot_fretboard-6.png index 3d48b8c..c132dbf 100644 Binary files a/docs/reference/plot_fretboard-6.png and b/docs/reference/plot_fretboard-6.png differ diff --git a/docs/reference/plot_fretboard-7.png b/docs/reference/plot_fretboard-7.png index d712c13..ec29271 100644 Binary files a/docs/reference/plot_fretboard-7.png and b/docs/reference/plot_fretboard-7.png differ diff --git a/docs/reference/plot_fretboard-8.png b/docs/reference/plot_fretboard-8.png index fa0800a..5fd5fc7 100644 Binary files a/docs/reference/plot_fretboard-8.png and b/docs/reference/plot_fretboard-8.png differ diff --git a/docs/reference/plot_fretboard.html b/docs/reference/plot_fretboard.html index 98e6c8c..ce91ca2 100644 --- a/docs/reference/plot_fretboard.html +++ b/docs/reference/plot_fretboard.html @@ -1,9 +1,9 @@ -Chord and fretboard diagram plots — plot_fretboard • tabrChord and fretboard diagram plots — plot_fretboard • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -190,105 +190,105 @@

    Chord and fretboard diagram plots

    Arguments

    -
    string
    + + +
    string

    integer or as a space-delimited character string; instrument string numbers.

    -
    fret
    +
    fret

    integer or as a space-delimited character string; fret numbers.

    -
    labels
    +
    labels

    NULL or character, optional vector of text labels, must be one for every point; or just the special value "notes".

    -
    mute
    +
    mute

    logical vector or specific integer indices, which notes to mute. See details.

    -
    label_size
    +
    label_size

    numeric, size of fretted note labels.

    -
    label_color
    +
    label_color

    character, label color.

    -
    point_size
    +
    point_size

    numeric, size of fretted note points.

    -
    point_color
    +
    point_color

    character, point color.

    -
    point_fill
    +
    point_fill

    character, point fill color.

    -
    group
    +
    group

    optional vector to facet by.

    -
    horizontal
    +
    horizontal

    logical, directional orientation.

    -
    left_handed
    +
    left_handed

    logical, handedness orientation.

    -
    fret_range
    +
    fret_range

    fret limits, if not NULL, overrides limits derived from fret.

    -
    fret_labels
    +
    fret_labels

    integer, vector of fret number labels for fret axis. See details.

    -
    fret_offset
    +
    fret_offset

    logical set to TRUE to shift the fret axis number labels (if present) from being directly next to the fret to being aligned with the circles behind the fret.

    -
    accidentals
    +
    accidentals

    character, when labels = "notes" represent accidentals: "flat" or "sharp".

    -
    tuning
    +
    tuning

    explicit tuning, e.g., "e, a, d g b e'", or a pre-defined tuning. See details.

    -
    show_tuning
    +
    show_tuning

    logical, show tuning of each string on string axis.

    -
    asp
    +
    asp

    numeric, aspect ratio, overrides default aspect ratio derived from number of strings and frets.

    -
    base_size
    +
    base_size

    base size for ggplot2::theme_void().

    -
    chord
    +
    chord

    character, a single chord given in fret notation. See details.

    Value

    - - -

    a ggplot object

    +

    a ggplot object

    Details

    @@ -369,15 +369,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/plot_music.html b/docs/reference/plot_music.html index 9b73e0d..df51c80 100644 --- a/docs/reference/plot_music.html +++ b/docs/reference/plot_music.html @@ -1,12 +1,12 @@ -Plot sheet music snippet with LilyPond — plot_music • tabrPlot sheet music snippet with LilyPond — plot_music • tabr - +
    @@ -28,14 +28,14 @@
    - +
    @@ -217,58 +217,58 @@

    Plot sheet music snippet with LilyPond

    Arguments

    -
    music
    + + +
    music

    a music object.

    -
    clef
    +
    clef

    character, include a music staff with the given clef. NA to suppress. See track() for details.

    -
    tab
    +
    tab

    logical, include tablature staff. NA to suppress. See track().

    -
    tuning
    +
    tuning

    character, string tuning, only applies to tablature. See track().

    -
    string_names
    +
    string_names

    label strings at beginning of tab staff. NULL (default) for non-standard tunings only, TRUE or FALSE for force on or off completely.

    -
    header
    +
    header

    a named list of arguments passed to the header of the LilyPond file. See lilypond() details.

    -
    paper
    +
    paper

    a named list of arguments for the LilyPond file page layout. See lilypond() details.

    -
    colors
    +
    colors

    a named list of LilyPond element color global overrides. See lilypond() for details.

    -
    transparent
    +
    transparent

    logical, transparent background for intermediate png file.

    -
    res
    +
    res

    numeric, resolution, png only. Defaults to 300.

    Value

    - - -

    a plot

    +

    a plot

    Details

    @@ -293,7 +293,7 @@

    Examples

    y <- "a,,4;3*5 b,,4- c,4 c,g,c~4 c,g,c1 c4;1 g,;2 c,;3 g,;2 c,c1;31" y <- as_music(y) -if (FALSE) { +if (FALSE) { # \dontrun{ if(tabr_options()$lilypond != ""){ # requires LilyPond installation plot_music(x) plot_music(x, "treble_8", tab = TRUE) @@ -305,7 +305,7 @@

    Examples

    plot_music_guitar(x) plot_music_bass(y) } -} +} # }
    @@ -320,15 +320,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/plot_music_bass.html b/docs/reference/plot_music_bass.html new file mode 100644 index 0000000..652fbf0 --- /dev/null +++ b/docs/reference/plot_music_bass.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/plot_music_bc.html b/docs/reference/plot_music_bc.html new file mode 100644 index 0000000..652fbf0 --- /dev/null +++ b/docs/reference/plot_music_bc.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/plot_music_guitar.html b/docs/reference/plot_music_guitar.html new file mode 100644 index 0000000..652fbf0 --- /dev/null +++ b/docs/reference/plot_music_guitar.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/plot_music_tab.html b/docs/reference/plot_music_tab.html new file mode 100644 index 0000000..652fbf0 --- /dev/null +++ b/docs/reference/plot_music_tab.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/plot_music_tc.html b/docs/reference/plot_music_tc.html new file mode 100644 index 0000000..652fbf0 --- /dev/null +++ b/docs/reference/plot_music_tc.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pn.html b/docs/reference/pn.html new file mode 100644 index 0000000..0f85664 --- /dev/null +++ b/docs/reference/pn.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/pretty_notes.html b/docs/reference/pretty_notes.html new file mode 100644 index 0000000..3899d17 --- /dev/null +++ b/docs/reference/pretty_notes.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/ratio_to_cents.html b/docs/reference/ratio_to_cents.html index d61c800..3c10135 100644 --- a/docs/reference/ratio_to_cents.html +++ b/docs/reference/ratio_to_cents.html @@ -1,9 +1,9 @@ -Convert between chord frequency ratios and cents — ratio_to_cents • tabrConvert between chord frequency ratios and cents — ratio_to_cents • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -150,20 +150,20 @@

    Convert between chord frequency ratios and cents

    Arguments

    -
    x
    + + +
    x

    a vector of ratios if y = NULL, otherwise frequencies. Cents for cents_to_ratio().

    -
    y
    +
    y

    if not NULL, frequencies and the ratios are given by y / x.

    Value

    - - -

    numeric

    +

    numeric

    @@ -186,15 +186,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/read_midi.html b/docs/reference/read_midi.html index 5bd61eb..43efd3d 100644 --- a/docs/reference/read_midi.html +++ b/docs/reference/read_midi.html @@ -1,10 +1,10 @@ -Read, inspect and convert MIDI file contents — read_midi • tabrRead, inspect and convert MIDI file contents — read_midi • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -162,34 +162,34 @@

    Read, inspect and convert MIDI file contents

    Arguments

    -
    file
    + + +
    file

    character, path to MIDI file.

    -
    ticks_per_qtr
    +
    ticks_per_qtr

    ticks per quarter note. Used to compute durations from MIDI file ticks.

    -
    x
    +
    x

    a data frame returned by read_midi(). An integer vector for ticks_to_duration(); a character vector (may be a space-delimited string) for duration_to_ticks().

    -
    channel, track
    +
    channel, track

    integer, filter rows on channel or track.

    -
    noteworthy
    +
    noteworthy

    logical, convert to noteworthy and noteinfo data.

    Value

    - - -

    a tibble data frame

    +

    a tibble data frame

    Details

    @@ -245,15 +245,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/render_chordchart.html b/docs/reference/render_chordchart.html index b451b47..62dee04 100644 --- a/docs/reference/render_chordchart.html +++ b/docs/reference/render_chordchart.html @@ -1,10 +1,10 @@ -Render a chord chart with LilyPond — render_chordchart • tabrRender a chord chart with LilyPond — render_chordchart • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -162,61 +162,61 @@

    Render a chord chart with LilyPond

    Arguments

    -
    chords
    + + +
    chords

    named character vector of valid formatting for LilyPond chord names and values. See examples.

    -
    file
    +
    file

    output file.

    -
    size
    +
    size

    numeric, size of fretboard diagrams (relative to paper font size). Use this to scale diagrams up or down.

    -
    header
    +
    header

    a named list of arguments passed to the header of the LilyPond file. See details.

    -
    paper
    +
    paper

    a named list of arguments for the LilyPond file page layout. See details.

    -
    colors
    +
    colors

    reserved; not yet implemented for this function.

    -
    crop_png
    +
    crop_png

    logical, see lilypond() for details.

    -
    transparent
    +
    transparent

    logical, transparent background, png only.

    -
    res
    +
    res

    numeric, resolution, png only. transparent = TRUE may fail when res exceeds ~150.

    -
    keep_ly
    +
    keep_ly

    logical, keep intermediate LilyPond file.

    -
    details
    +
    details

    logical, set to TRUE to print LilyPond log output to console. Windows only.

    Value

    - - -

    writes files to disk

    +

    writes files to disk

    Details

    @@ -284,15 +284,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/render_midi.html b/docs/reference/render_midi.html new file mode 100644 index 0000000..c8a6bfa --- /dev/null +++ b/docs/reference/render_midi.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/render_music.html b/docs/reference/render_music.html index 9f69074..d7aa821 100644 --- a/docs/reference/render_music.html +++ b/docs/reference/render_music.html @@ -1,9 +1,9 @@ -Render sheet music snippet with LilyPond — render_music • tabrRender sheet music snippet with LilyPond — render_music • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -235,76 +235,76 @@

    Render sheet music snippet with LilyPond

    Arguments

    -
    music
    + + +
    music

    a music object.

    -
    file
    +
    file

    character, output file ending in .pdf or .png.

    -
    clef
    +
    clef

    character, include a music staff with the given clef. NA to suppress. See track() for details.

    -
    tab
    +
    tab

    logical, include tablature staff. NA to suppress. See track().

    -
    tuning
    +
    tuning

    character, string tuning, only applies to tablature. See track().

    -
    string_names
    +
    string_names

    label strings at beginning of tab staff. NULL (default) for non-standard tunings only, TRUE or FALSE for force on or off completely.

    -
    header
    +
    header

    a named list of arguments passed to the header of the LilyPond file. See lilypond() details.

    -
    paper
    +
    paper

    a named list of arguments for the LilyPond file page layout. See lilypond() details.

    -
    midi
    +
    midi

    logical, also output an corresponding MIDI file.

    -
    colors
    +
    colors

    a named list of LilyPond element color global overrides. See lilypond() for details.

    -
    transparent
    +
    transparent

    logical, transparent background, png only.

    -
    res
    +
    res

    numeric, resolution, png only. transparent = TRUE may fail when res exceeds ~150.

    -
    keep_ly
    +
    keep_ly

    logical, keep the intermediary LilyPond file.

    -
    simplify
    +
    simplify

    logical, uses simplify_phrase() to convert to simpler, more efficient LilyPond syntax.

    Value

    - - -

    nothing returned; a file is written.

    +

    nothing returned; a file is written.

    Details

    @@ -375,7 +375,7 @@

    Examples

    z <- as_music("a,4 b, r c~ c2 d", lyrics = as_lyrics("A2 B2 . C3 . D3")) -if (FALSE) { +if (FALSE) { # \dontrun{ if(tabr_options()$lilypond != ""){ # requires LilyPond installation outfile <- file.path(tempdir(), "out.pdf") render_music(x, outfile) @@ -393,7 +393,7 @@

    Examples

    # lyrics example render_music_guitar(z, outfile) } -} +} # }
    @@ -408,15 +408,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/render_music_bass.html b/docs/reference/render_music_bass.html new file mode 100644 index 0000000..e7beb17 --- /dev/null +++ b/docs/reference/render_music_bass.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/render_music_bc.html b/docs/reference/render_music_bc.html new file mode 100644 index 0000000..e7beb17 --- /dev/null +++ b/docs/reference/render_music_bc.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/render_music_guitar.html b/docs/reference/render_music_guitar.html new file mode 100644 index 0000000..e7beb17 --- /dev/null +++ b/docs/reference/render_music_guitar.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/render_music_tab.html b/docs/reference/render_music_tab.html new file mode 100644 index 0000000..e7beb17 --- /dev/null +++ b/docs/reference/render_music_tab.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/render_music_tc.html b/docs/reference/render_music_tc.html new file mode 100644 index 0000000..e7beb17 --- /dev/null +++ b/docs/reference/render_music_tc.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/render_score.html b/docs/reference/render_score.html new file mode 100644 index 0000000..c8a6bfa --- /dev/null +++ b/docs/reference/render_score.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/render_tab.html b/docs/reference/render_tab.html new file mode 100644 index 0000000..c8a6bfa --- /dev/null +++ b/docs/reference/render_tab.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/rep.lyrics.html b/docs/reference/rep.lyrics.html new file mode 100644 index 0000000..4faa497 --- /dev/null +++ b/docs/reference/rep.lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/rep.music.html b/docs/reference/rep.music.html new file mode 100644 index 0000000..4faa497 --- /dev/null +++ b/docs/reference/rep.music.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/rep.noteinfo.html b/docs/reference/rep.noteinfo.html new file mode 100644 index 0000000..4faa497 --- /dev/null +++ b/docs/reference/rep.noteinfo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/rep.noteworthy.html b/docs/reference/rep.noteworthy.html new file mode 100644 index 0000000..4faa497 --- /dev/null +++ b/docs/reference/rep.noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/rep.phrase.html b/docs/reference/rep.phrase.html new file mode 100644 index 0000000..4faa497 --- /dev/null +++ b/docs/reference/rep.phrase.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/repeats.html b/docs/reference/repeats.html index 6d6606d..d3d8839 100644 --- a/docs/reference/repeats.html +++ b/docs/reference/repeats.html @@ -1,9 +1,9 @@ -Repeat phrases — repeats • tabrRepeat phrases — repeats • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -152,46 +152,46 @@

    Repeat phrases

    Arguments

    -
    phrase
    + + +
    phrase

    a phrase object or equivalent string to be repeated.

    -
    n
    +
    n

    integer, number of repeats of phrase (one less than the total number of plays).

    -
    counter
    +
    counter

    logical, if TRUE, print the percent repeat counter above the staff, applies only to measure repeats of more than two repeats (n > 2).

    -
    step
    +
    step

    integer, print the measure percent repeat counter above the staff only at every step measures when counter = TRUE.

    -
    reset
    +
    reset

    logical, percent repeat counter and step settings are only applied to the single pct() call and are reset afterward. If reset = FALSE, the settings are left open to apply to any subsequent percent repeat sections in a track.

    -
    endings
    +
    endings

    a single phrase or a list of phrases, alternate endings.

    -
    silent
    +
    silent

    if TRUE, no text will be printed above the staff at the beginning of a volta section. See details.

    Value

    - - -

    a phrase.

    +

    a phrase.

    Details

    @@ -298,15 +298,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/rest.html b/docs/reference/rest.html index ea125ec..995d098 100644 --- a/docs/reference/rest.html +++ b/docs/reference/rest.html @@ -1,10 +1,10 @@ -Create rests — rest • tabrCreate rests — rest • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -150,19 +150,19 @@

    Create rests

    Arguments

    -
    x
    + + +
    x

    integer, duration.

    -
    n
    +
    n

    integer, number of repetitions.

    Value

    - - -

    a character string.

    +

    a character string.

    @@ -183,15 +183,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/rev.lyrics.html b/docs/reference/rev.lyrics.html new file mode 100644 index 0000000..072b366 --- /dev/null +++ b/docs/reference/rev.lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/rev.music.html b/docs/reference/rev.music.html new file mode 100644 index 0000000..072b366 --- /dev/null +++ b/docs/reference/rev.music.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/rev.noteinfo.html b/docs/reference/rev.noteinfo.html new file mode 100644 index 0000000..072b366 --- /dev/null +++ b/docs/reference/rev.noteinfo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/rev.noteworthy.html b/docs/reference/rev.noteworthy.html new file mode 100644 index 0000000..072b366 --- /dev/null +++ b/docs/reference/rev.noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/rp.html b/docs/reference/rp.html new file mode 100644 index 0000000..f2df233 --- /dev/null +++ b/docs/reference/rp.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale-deg.html b/docs/reference/scale-deg.html index 4017820..ffa744c 100644 --- a/docs/reference/scale-deg.html +++ b/docs/reference/scale-deg.html @@ -1,9 +1,9 @@ -Scale degrees and mappings — scale-deg • tabrScale degrees and mappings — scale-deg • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -177,57 +177,57 @@

    Scale degrees and mappings

    Arguments

    -
    notes
    + + +
    notes

    character, a string of notes.

    -
    key
    +
    key

    character, key signature (or root note) for scale, depending on the type of scale.

    -
    scale
    +
    scale

    character, the suffix of a supported scale_* function.

    -
    use_root
    +
    use_root

    logical, use lowest pitch in chord. Otherwise yield an NA in output.

    -
    strict_accidentals
    +
    strict_accidentals

    logical, whether representation must match key and scale. See details.

    -
    naturalize
    +
    naturalize

    logical, whether to naturalize any sharps or flats before obtaiuning the scale degree.

    -
    roman
    +
    roman

    logical, return integer scale degrees as Roman numerals.

    -
    deg
    +
    deg

    integer, roman class, or character roman, the scale degree.

    -
    collapse
    +
    collapse

    logical, collapse result into a single string ready for phrase construction.

    -
    ...
    +
    ...

    additional arguments passed to the scale function, e.g., sharp = FALSE for scale_chromatic().

    Value

    - - -

    integer, or roman class if roman = TRUE for scale_degree(); +

    integer, or roman class if roman = TRUE for scale_degree(); character for scale_note().

    @@ -324,15 +324,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/scale-helpers.html b/docs/reference/scale-helpers.html index 9cdafc5..0b868a6 100644 --- a/docs/reference/scale-helpers.html +++ b/docs/reference/scale-helpers.html @@ -1,9 +1,9 @@ -Scale helpers — scale-helpers • tabrScale helpers — scale-helpers • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -172,40 +172,40 @@

    Scale helpers

    Arguments

    -
    key
    + + +
    key

    character, key signature.

    -
    collapse
    +
    collapse

    logical, collapse result into a single string ready for phrase construction.

    -
    ignore_octave
    +
    ignore_octave

    logical, strip octave numbering from scales not rooted on C.

    -
    descending
    +
    descending

    logical, return the descending scale, available as a built-in argument for the melodic minor scale, which is different in each direction.

    -
    root
    +
    root

    character, root note.

    -
    sharp
    +
    sharp

    logical, accidentals in arbitrary scale output should be sharp rather than flat.

    Value

    - - -

    character

    +

    character

    Details

    @@ -269,15 +269,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/scale_chords.html b/docs/reference/scale_chords.html index 29c9529..e346c17 100644 --- a/docs/reference/scale_chords.html +++ b/docs/reference/scale_chords.html @@ -1,10 +1,10 @@ -Diatonic chords — scale_chords • tabrDiatonic chords — scale_chords • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -155,29 +155,29 @@

    Diatonic chords

    Arguments

    -
    root
    + + +
    root

    character, root note or starting position of scale.

    -
    scale
    +
    scale

    character, a valid named scale, referring to one of the existing scale_* functions.

    -
    type
    +
    type

    character, type of chord, triad or seventh.

    -
    collapse
    +
    collapse

    logical, collapse result into a single string ready for phrase construction.

    Value

    - - -

    character

    +

    character

    @@ -229,15 +229,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/scale_chromatic.html b/docs/reference/scale_chromatic.html new file mode 100644 index 0000000..da0db5a --- /dev/null +++ b/docs/reference/scale_chromatic.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_degree.html b/docs/reference/scale_degree.html new file mode 100644 index 0000000..a9b1576 --- /dev/null +++ b/docs/reference/scale_degree.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_diatonic.html b/docs/reference/scale_diatonic.html new file mode 100644 index 0000000..da0db5a --- /dev/null +++ b/docs/reference/scale_diatonic.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_diff.html b/docs/reference/scale_diff.html new file mode 100644 index 0000000..34c1ad5 --- /dev/null +++ b/docs/reference/scale_diff.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_harmonic_minor.html b/docs/reference/scale_harmonic_minor.html new file mode 100644 index 0000000..da0db5a --- /dev/null +++ b/docs/reference/scale_harmonic_minor.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_hungarian_minor.html b/docs/reference/scale_hungarian_minor.html new file mode 100644 index 0000000..da0db5a --- /dev/null +++ b/docs/reference/scale_hungarian_minor.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_interval.html b/docs/reference/scale_interval.html new file mode 100644 index 0000000..34c1ad5 --- /dev/null +++ b/docs/reference/scale_interval.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_jazz_minor.html b/docs/reference/scale_jazz_minor.html new file mode 100644 index 0000000..da0db5a --- /dev/null +++ b/docs/reference/scale_jazz_minor.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_major.html b/docs/reference/scale_major.html new file mode 100644 index 0000000..da0db5a --- /dev/null +++ b/docs/reference/scale_major.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_melodic_minor.html b/docs/reference/scale_melodic_minor.html new file mode 100644 index 0000000..da0db5a --- /dev/null +++ b/docs/reference/scale_melodic_minor.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_minor.html b/docs/reference/scale_minor.html new file mode 100644 index 0000000..da0db5a --- /dev/null +++ b/docs/reference/scale_minor.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/scale_note.html b/docs/reference/scale_note.html new file mode 100644 index 0000000..a9b1576 --- /dev/null +++ b/docs/reference/scale_note.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/score.html b/docs/reference/score.html index 8b99a61..f0238de 100644 --- a/docs/reference/score.html +++ b/docs/reference/score.html @@ -1,9 +1,9 @@ -Create a music score — score • tabrCreate a music score — score • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,25 +148,25 @@

    Create a music score

    Arguments

    -
    track
    + + +
    track

    a track table consisting of one or more tracks.

    -
    chords
    +
    chords

    an optional named list of chords and respective fingerings generated by chord_set, for inclusion of a top center chord diagram chart.

    -
    chord_seq
    +
    chord_seq

    an optional named vector of chords and their durations, for placing chord diagrams above staves in time.

    Value

    - - -

    a tibble data frame

    +

    a tibble data frame

    Details

    @@ -204,15 +204,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/seconds.html b/docs/reference/seconds.html new file mode 100644 index 0000000..9d517ac --- /dev/null +++ b/docs/reference/seconds.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/seconds_per_measure.html b/docs/reference/seconds_per_measure.html new file mode 100644 index 0000000..9d517ac --- /dev/null +++ b/docs/reference/seconds_per_measure.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/seconds_per_step.html b/docs/reference/seconds_per_step.html new file mode 100644 index 0000000..9d517ac --- /dev/null +++ b/docs/reference/seconds_per_step.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/semitone_freq.html b/docs/reference/semitone_freq.html new file mode 100644 index 0000000..f7c6798 --- /dev/null +++ b/docs/reference/semitone_freq.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/semitone_pitch.html b/docs/reference/semitone_pitch.html new file mode 100644 index 0000000..f7c6798 --- /dev/null +++ b/docs/reference/semitone_pitch.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/semitone_range.html b/docs/reference/semitone_range.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/semitone_range.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/semitone_span.html b/docs/reference/semitone_span.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/semitone_span.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/sf_note.html b/docs/reference/sf_note.html new file mode 100644 index 0000000..08c1103 --- /dev/null +++ b/docs/reference/sf_note.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/sf_phrase.html b/docs/reference/sf_phrase.html index 6834a95..1628aa6 100644 --- a/docs/reference/sf_phrase.html +++ b/docs/reference/sf_phrase.html @@ -1,11 +1,11 @@ -Create a musical phrase from string/fret combinations — sf_phrase • tabrCreate a musical phrase from string/fret combinations — sf_phrase • tabr - +
    @@ -27,14 +27,14 @@
    - +
    @@ -174,51 +174,51 @@

    Create a musical phrase from string/fret combinations

    Arguments

    -
    string
    + + +
    string

    character, space-delimited or vector. String numbers associated with notes. Alternatively, provide all information here in a single space-delimited string and ignore fret and info. See details.

    -
    fret
    +
    fret

    character, space-delimited or vector (or integer vector) of fret numbers associated with notes. Same number of timesteps as string.

    -
    info
    +
    info

    character, space-delimited or vector (or integer vector if simple durations) giving metadata associated with notes. Same number of timesteps as string.

    -
    key
    +
    key

    character, key signature or just specify "sharp" or "flat".

    -
    tuning
    +
    tuning

    character, instrument tuning.

    -
    to_notes
    +
    to_notes

    logical, return only the mapped notes character string rather than the entire phrase object.

    -
    bar
    +
    bar

    character or NULL (default). Terminates the phrase with a bar or bar check. See details for phrase(). Also see the LilyPond help documentation on bar notation for all the valid options.

    -
    ...
    +
    ...

    arguments passed to sf_phrase().

    Value

    - - -

    a phrase.

    +

    a phrase.

    Details

    @@ -236,7 +236,7 @@

    Details

    Comparison with phrase()

    - +

    This function is a wrapper function for users not working with musical notes (what to play), but rather just position on the guitar neck (where to play). @@ -278,7 +278,7 @@

    Comparison with phrase()

    Single-string input

    - +

    Another way to use sf_phrase() is to provide all musical input to string and ignore fret and info as explicit arguments. @@ -367,15 +367,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/sfn.html b/docs/reference/sfn.html new file mode 100644 index 0000000..08c1103 --- /dev/null +++ b/docs/reference/sfn.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/sfp.html b/docs/reference/sfp.html new file mode 100644 index 0000000..08c1103 --- /dev/null +++ b/docs/reference/sfp.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/sharpen_flat.html b/docs/reference/sharpen_flat.html new file mode 100644 index 0000000..3899d17 --- /dev/null +++ b/docs/reference/sharpen_flat.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/simplify_phrase.html b/docs/reference/simplify_phrase.html index aef0864..5056f15 100644 --- a/docs/reference/simplify_phrase.html +++ b/docs/reference/simplify_phrase.html @@ -1,10 +1,10 @@ -Simplify the LilyPond syntax of a phrase — simplify_phrase • tabrSimplify the LilyPond syntax of a phrase — simplify_phrase • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -150,15 +150,15 @@

    Simplify the LilyPond syntax of a phrase

    Arguments

    -
    phrase
    + + +
    phrase

    a phrase object.

    Value

    - - -

    character

    +

    character

    Details

    @@ -208,15 +208,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/single-bracket.html b/docs/reference/single-bracket.html index 0cd16d1..a96d780 100644 --- a/docs/reference/single-bracket.html +++ b/docs/reference/single-bracket.html @@ -1,10 +1,10 @@ -Single bracket methods for tabr classes — single-bracket • tabrSingle bracket methods for tabr classes — single-bracket • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -145,42 +145,44 @@

    Single bracket methods for tabr classes

    - 
    # S3 method for noteworthy
-[(x, i)
-
-# S3 method for noteinfo
-[(x, i)
-
-# S3 method for music
-[(x, i)
-
-# S3 method for lyrics
-[(x, i)
-
-# S3 method for noteworthy
-[(x, i) <- value
-
-# S3 method for noteinfo
-[(x, i) <- value
-
-# S3 method for music
-[(x, i) <- value
-
-# S3 method for lyrics
-[(x, i) <- value
    + 
    # S3 method for class 'noteworthy'
+x[i]
+
+# S3 method for class 'noteinfo'
+x[i]
+
+# S3 method for class 'music'
+x[i]
+
+# S3 method for class 'lyrics'
+x[i]
+
+# S3 method for class 'noteworthy'
+x[i] <- value
+
+# S3 method for class 'noteinfo'
+x[i] <- value
+
+# S3 method for class 'music'
+x[i] <- value
+
+# S3 method for class 'lyrics'
+x[i] <- value

    Arguments

    -
    x
    + + +
    x

    object.

    -
    i
    +
    i

    index.

    -
    value
    +
    value

    values to assign at index.

    @@ -256,15 +258,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/steps_per_measure.html b/docs/reference/steps_per_measure.html new file mode 100644 index 0000000..9d517ac --- /dev/null +++ b/docs/reference/steps_per_measure.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/steps_start_time.html b/docs/reference/steps_start_time.html new file mode 100644 index 0000000..9d517ac --- /dev/null +++ b/docs/reference/steps_start_time.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/string_fold.html b/docs/reference/string_fold.html new file mode 100644 index 0000000..c6b2333 --- /dev/null +++ b/docs/reference/string_fold.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/string_unfold.html b/docs/reference/string_unfold.html index de25d65..7fd2dfb 100644 --- a/docs/reference/string_unfold.html +++ b/docs/reference/string_unfold.html @@ -1,9 +1,9 @@ -Fold and unfold strings — string_unfold • tabrFold and unfold strings — string_unfold • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -150,20 +150,20 @@

    Fold and unfold strings

    Arguments

    -
    x
    + + +
    x

    character string, should be valid notes or note info such as beats.

    -
    n
    +
    n

    integer, minimum number of consecutive repeated values to warrant folding, defaults to 3.

    Value

    - - -

    character

    +

    character

    Details

    @@ -202,15 +202,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tab.html b/docs/reference/tab.html index 06a1763..d4c4bca 100644 --- a/docs/reference/tab.html +++ b/docs/reference/tab.html @@ -1,9 +1,9 @@ -Render sheet music with LilyPond — tab • tabrRender sheet music with LilyPond — tab • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -206,90 +206,90 @@

    Render sheet music with LilyPond

    Arguments

    -
    score
    + + +
    score

    a score object.

    -
    file
    +
    file

    character, output file ending in .pdf or .png for sheet music or tablature for score(). May include an absolute or relative path. For render_midi(), a file ending in .mid.

    -
    key
    +
    key

    character, key signature, e.g., c, b_, f#m, etc.

    -
    time
    +
    time

    character, defaults to "4/4".

    -
    tempo
    +
    tempo

    character, defaults to "2 = 60". Set to NULL to suppress display of the time signature in the output.

    -
    header
    +
    header

    a named list of arguments passed to the header of the LilyPond file. See lilypond() for details.

    -
    paper
    +
    paper

    a named list of arguments for the LilyPond file page layout. See lilypond() for details.

    -
    string_names
    +
    string_names

    label strings at beginning of tab staff. NULL (default) for non-standard tunings only, TRUE or FALSE for force on or off completely.

    -
    endbar
    +
    endbar

    character, the global end bar.

    -
    midi
    +
    midi

    logical, output midi file in addition to sheet music.

    -
    colors
    +
    colors

    a named list of LilyPond element color overrides. See lilypond() for details.

    -
    crop_png
    +
    crop_png

    logical, see lilypond() for details.

    -
    transparent
    +
    transparent

    logical, transparent background, png only.

    -
    res
    +
    res

    numeric, resolution, png only. transparent = TRUE may fail when res exceeds ~150.

    -
    keep_ly
    +
    keep_ly

    logical, keep the intermediary LilyPond file.

    -
    simplify
    +
    simplify

    logical, uses simplify_phrase() to convert to simpler, more efficient LilyPond syntax for the LilyPond file before rendering it.

    -
    details
    +
    details

    logical, set to TRUE to print LilyPond log output to console. Windows only.

    Value

    - - -

    nothing returned; a file is written.

    +

    nothing returned; a file is written.

    Details

    @@ -349,15 +349,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tabr-c.html b/docs/reference/tabr-c.html index 4acd5ff..2f35389 100644 --- a/docs/reference/tabr-c.html +++ b/docs/reference/tabr-c.html @@ -1,10 +1,10 @@ -Concatenate for tabr classes — tabr-c • tabrConcatenate for tabr classes — tabr-c • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -145,25 +145,27 @@

    Concatenate for tabr classes

    - 
    # S3 method for noteworthy
+    
    # S3 method for class 'noteworthy'
 c(...)
 
-# S3 method for noteinfo
+# S3 method for class 'noteinfo'
 c(...)
 
-# S3 method for music
+# S3 method for class 'music'
 c(...)
 
-# S3 method for lyrics
+# S3 method for class 'lyrics'
 c(...)
 
-# S3 method for phrase
+# S3 method for class 'phrase'
 c(...)

    Arguments

    -
    ...
    + + +
    ...

    objects.

    @@ -215,15 +217,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tabr-details.html b/docs/reference/tabr-details.html new file mode 100644 index 0000000..6d7aa00 --- /dev/null +++ b/docs/reference/tabr-details.html @@ -0,0 +1,213 @@ + +tabr: Additional Detals — tabr-details • tabr + + +
    +
    + + + +
    +
    +
    +

    tabr: Additional Detals

    + Source: R/tabr.R + +
    + +
    +

    The tabr package provides a music notation syntax and a collection of music +programming functions for generating, manipulating, organizing and analyzing +musical information in R. The music notation framework facilitates creating +and analyzing music data in notation form.

    +
    + + +
    +

    Details

    +

    Music syntax can be entered directly in character strings, for example to +quickly transcribe short pieces of music. The package contains functions for +directly performing various mathematical, logical and organizational +operations and musical transformations on special object classes that +facilitate working with music data and notation. The same music data can be +organized in tidy data frames for a familiar and powerful approach to the +analysis of large amounts of structured music data. Functions are available +for mapping seamlessly between these formats and their representations of +musical information.

    +

    The package also provides an API to 'LilyPond' (https://lilypond.org/) for +transcribing musical representations in R into tablature ("tabs") and sheet +music. 'LilyPond' is open source music engraving software for generating high +quality sheet music based on markup syntax. The package generates 'LilyPond' +files from R code and can pass them to the 'LilyPond' command line interface +to be rendered into sheet music PDF files or inserted into R markdown +documents.

    +

    The package offers nominal MIDI file output support in conjunction with +rendering sheet music. The package can read MIDI files and attempts to +structure the MIDI data to integrate as best as possible with the data +structures and functionality found throughout the package.

    +

    tabr offers a useful but limited LilyPond API and is not intended to +access all LilyPond functionality from R, +nor is transcription via the API the entire scope of tabr. +If you are only creating sheet music on a case by case basis, write your own +LilyPond files manually. +There is no need to use tabr or limit yourself to its existing +LilyPond API. +If you are generating music notation programmatically, +tabr provides the ability to do so in R and has the added benefit of +converting what you write in R code to the LilyPond file format to be +rendered as printable guitar tablature.

    +

    While LilyPond is listed as a system requirement for tabr, you can +use the package for music analysis without installing LilyPond if you do not +intend to render tabs.

    +
    + +
    + +
    + + +
    + + + + + + + + diff --git a/docs/reference/tabr-head.html b/docs/reference/tabr-head.html index c901d07..80d856a 100644 --- a/docs/reference/tabr-head.html +++ b/docs/reference/tabr-head.html @@ -1,10 +1,10 @@ -Head and tail for tabr classes — tabr-head • tabrHead and tail for tabr classes — tabr-head • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -145,38 +145,40 @@

    Head and tail for tabr classes

    - 
    # S3 method for noteworthy
+    
    # S3 method for class 'noteworthy'
 head(x, ...)
 
-# S3 method for noteinfo
+# S3 method for class 'noteinfo'
 head(x, ...)
 
-# S3 method for music
+# S3 method for class 'music'
 head(x, ...)
 
-# S3 method for lyrics
+# S3 method for class 'lyrics'
 head(x, ...)
 
-# S3 method for noteworthy
+# S3 method for class 'noteworthy'
 tail(x, ...)
 
-# S3 method for noteinfo
+# S3 method for class 'noteinfo'
 tail(x, ...)
 
-# S3 method for music
+# S3 method for class 'music'
 tail(x, ...)
 
-# S3 method for lyrics
+# S3 method for class 'lyrics'
 tail(x, ...)

    Arguments

    -
    x
    + + +
    x

    object.

    -
    ...
    +
    ...

    number of elements to return.

    @@ -235,15 +237,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tabr-length.html b/docs/reference/tabr-length.html index e865c3a..eb1740b 100644 --- a/docs/reference/tabr-length.html +++ b/docs/reference/tabr-length.html @@ -1,10 +1,10 @@ -Length for tabr classes — tabr-length • tabrLength for tabr classes — tabr-length • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -145,22 +145,24 @@

    Length for tabr classes

    - 
    # S3 method for noteworthy
+    
    # S3 method for class 'noteworthy'
 length(x)
 
-# S3 method for noteinfo
+# S3 method for class 'noteinfo'
 length(x)
 
-# S3 method for music
+# S3 method for class 'music'
 length(x)
 
-# S3 method for lyrics
+# S3 method for class 'lyrics'
 length(x)

    Arguments

    -
    x
    + + +
    x

    object.

    @@ -207,15 +209,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tabr-methods.html b/docs/reference/tabr-methods.html index b7b7ac0..cde73e3 100644 --- a/docs/reference/tabr-methods.html +++ b/docs/reference/tabr-methods.html @@ -1,11 +1,11 @@ -Summary of implemented S3 generic methods — tabr-methods • tabrSummary of implemented S3 generic methods — tabr-methods • tabr - +
    @@ -27,14 +27,14 @@
    - +
    @@ -149,19 +149,21 @@

    Summary of implemented S3 generic methods

    Arguments

    -
    x
    + + +
    x

    object.

    -
    i
    +
    i

    index.

    -
    value
    +
    value

    values to assign at index.

    -
    ...
    +
    ...

    additional arguments.

    @@ -174,7 +176,7 @@

    Details

    Methods length() and c()

    - +

    The implementation of length() is equivalent to n_steps(). They access the same attribute, returning the number of timesteps in the object. @@ -201,7 +203,7 @@

    Methods

    Methods rep() rev() head() and tail()

    - +

    The rep() function is similar to c() except that it never has to consider other classes. You could pass a vector of objects to rep(), but doing so @@ -221,7 +223,7 @@

    Methods

    Square brackets

    - +

    Single and double bracket subsetting by index work similarly to what occurs with lists. Single bracket subsetting returns the same object, but only @@ -235,7 +237,7 @@

    Square brackets

    Limited phrase implementations

    - +

    Methods implemented for the phrase class are limited to c() and rep(). Due to the complex LilyPond syntax, applying most of the functions above @@ -365,15 +367,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tabr-package.html b/docs/reference/tabr-package.html new file mode 100644 index 0000000..30a4b7e --- /dev/null +++ b/docs/reference/tabr-package.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tabr-rep.html b/docs/reference/tabr-rep.html index 363534e..98070b3 100644 --- a/docs/reference/tabr-rep.html +++ b/docs/reference/tabr-rep.html @@ -1,10 +1,10 @@ -Repeat for tabr classes — tabr-rep • tabrRepeat for tabr classes — tabr-rep • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -145,29 +145,31 @@

    Repeat for tabr classes

    - 
    # S3 method for noteworthy
+    
    # S3 method for class 'noteworthy'
 rep(x, ...)
 
-# S3 method for noteinfo
+# S3 method for class 'noteinfo'
 rep(x, ...)
 
-# S3 method for music
+# S3 method for class 'music'
 rep(x, ...)
 
-# S3 method for lyrics
+# S3 method for class 'lyrics'
 rep(x, ...)
 
-# S3 method for phrase
+# S3 method for class 'phrase'
 rep(x, ...)

    Arguments

    -
    x
    + + +
    x

    object.

    -
    ...
    +
    ...

    additional arguments. Not accepted for phrase objects.

    @@ -219,15 +221,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tabr-rev.html b/docs/reference/tabr-rev.html index 6f2afa9..1cb5971 100644 --- a/docs/reference/tabr-rev.html +++ b/docs/reference/tabr-rev.html @@ -1,10 +1,10 @@ -Reverse for tabr classes — tabr-rev • tabrReverse for tabr classes — tabr-rev • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -145,22 +145,24 @@

    Reverse for tabr classes

    - 
    # S3 method for noteworthy
+    
    # S3 method for class 'noteworthy'
 rev(x)
 
-# S3 method for noteinfo
+# S3 method for class 'noteinfo'
 rev(x)
 
-# S3 method for music
+# S3 method for class 'music'
 rev(x)
 
-# S3 method for lyrics
+# S3 method for class 'lyrics'
 rev(x)

    Arguments

    -
    x
    + + +
    x

    object.

    @@ -207,15 +209,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tabr.html b/docs/reference/tabr.html index 90cfe0a..54d5f17 100644 --- a/docs/reference/tabr.html +++ b/docs/reference/tabr.html @@ -1,12 +1,10 @@ -tabr: Music notation syntax, manipulation, analysis and transcription in R. — tabr • tabrtabr: Music Notation Syntax, Manipulation, Analysis and Transcription in R — tabr • tabr - +
    @@ -28,14 +26,14 @@
    - +
    -

    tabr: Music notation syntax, manipulation, analysis and transcription in R.

    +

    tabr: Music Notation Syntax, Manipulation, Analysis and Transcription in R

    Source: R/tabr.R
    -

    The tabr package provides a music notation syntax and a collection of music -programming functions for generating, manipulating, organizing and analyzing -musical information in R. The music notation framework facilitates creating -and analyzing music data in notation form.

    +

    +

    Provides a music notation syntax and a collection of music programming functions for generating, manipulating, organizing, and analyzing musical information in R. Music syntax can be entered directly in character strings, for example to quickly transcribe short pieces of music. The package contains functions for directly performing various mathematical, logical and organizational operations and musical transformations on special object classes that facilitate working with music data and notation. The same music data can be organized in tidy data frames for a familiar and powerful approach to the analysis of large amounts of structured music data. Functions are available for mapping seamlessly between these formats and their representations of musical information. The package also provides an API to 'LilyPond' (https://lilypond.org/) for transcribing musical representations in R into tablature ("tabs") and sheet music. 'LilyPond' is open source music engraving software for generating high quality sheet music based on markup syntax. The package generates 'LilyPond' files from R code and can pass them to the 'LilyPond' command line interface to be rendered into sheet music PDF files or inserted into R markdown documents. The package offers nominal MIDI file output support in conjunction with rendering sheet music. The package can read MIDI files and attempts to structure the MIDI data to integrate as best as possible with the data structures and functionality found throughout the package.

    -
    -

    Details

    -

    Music syntax can be entered directly in character strings, for example to -quickly transcribe short pieces of music. The package contains functions for -directly performing various mathematical, logical and organizational -operations and musical transformations on special object classes that -facilitate working with music data and notation. The same music data can be -organized in tidy data frames for a familiar and powerful approach to the -analysis of large amounts of structured music data. Functions are available -for mapping seamlessly between these formats and their representations of -musical information.

    -

    The package also provides an API to 'LilyPond' (https://lilypond.org/) for -transcribing musical representations in R into tablature ("tabs") and sheet -music. 'LilyPond' is open source music engraving software for generating high -quality sheet music based on markup syntax. The package generates 'LilyPond' -files from R code and can pass them to the 'LilyPond' command line interface -to be rendered into sheet music PDF files or inserted into R markdown -documents.

    -

    The package offers nominal MIDI file output support in conjunction with -rendering sheet music. The package can read MIDI files and attempts to -structure the MIDI data to integrate as best as possible with the data -structures and functionality found throughout the package.

    -

    tabr offers a useful but limited LilyPond API and is not intended to -access all LilyPond functionality from R, -nor is transcription via the API the entire scope of tabr. -If you are only creating sheet music on a case by case basis, write your own -LilyPond files manually. -There is no need to use tabr or limit yourself to its existing -LilyPond API. -If you are generating music notation programmatically, -tabr provides the ability to do so in R and has the added benefit of -converting what you write in R code to the LilyPond file format to be -rendered as printable guitar tablature.

    -

    While LilyPond is listed as a system requirement for tabr, you can -use the package for music analysis without installing LilyPond if you do not -intend to render tabs.

    + +
    +

    Author

    +

    Maintainer: Matthew Leonawicz rpkgs@pm.me (ORCID)

    @@ -199,15 +168,15 @@

    Details

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tabrSyntax.html b/docs/reference/tabrSyntax.html index 3b721d5..fef6d16 100644 --- a/docs/reference/tabrSyntax.html +++ b/docs/reference/tabrSyntax.html @@ -1,10 +1,10 @@ -tabr syntax — tabrSyntax • tabrtabr syntax — tabrSyntax • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -166,15 +166,15 @@

    Format

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tabr_lilypond_api.html b/docs/reference/tabr_lilypond_api.html new file mode 100644 index 0000000..affe160 --- /dev/null +++ b/docs/reference/tabr_lilypond_api.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tabr_options.html b/docs/reference/tabr_options.html index 1db003e..71864ba 100644 --- a/docs/reference/tabr_options.html +++ b/docs/reference/tabr_options.html @@ -1,9 +1,9 @@ -Options — tabr_options • tabrOptions — tabr_options • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,15 +148,15 @@

    Options

    Arguments

    -
    ...
    + + +
    ...

    a list of options.

    Value

    - - -

    The function prints all set options if called with no arguments. +

    The function prints all set options if called with no arguments. When setting options, nothing is returned.

    @@ -195,15 +195,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tail.lyrics.html b/docs/reference/tail.lyrics.html new file mode 100644 index 0000000..498f37c --- /dev/null +++ b/docs/reference/tail.lyrics.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tail.music.html b/docs/reference/tail.music.html new file mode 100644 index 0000000..498f37c --- /dev/null +++ b/docs/reference/tail.music.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tail.noteinfo.html b/docs/reference/tail.noteinfo.html new file mode 100644 index 0000000..498f37c --- /dev/null +++ b/docs/reference/tail.noteinfo.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tail.noteworthy.html b/docs/reference/tail.noteworthy.html new file mode 100644 index 0000000..498f37c --- /dev/null +++ b/docs/reference/tail.noteworthy.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tally_notes.html b/docs/reference/tally_notes.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/tally_notes.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tally_octaves.html b/docs/reference/tally_octaves.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/tally_octaves.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tally_pitches.html b/docs/reference/tally_pitches.html new file mode 100644 index 0000000..20dc7f1 --- /dev/null +++ b/docs/reference/tally_pitches.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/ticks_to_duration.html b/docs/reference/ticks_to_duration.html new file mode 100644 index 0000000..12a353e --- /dev/null +++ b/docs/reference/ticks_to_duration.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tie.html b/docs/reference/tie.html index fa3a82e..a9c352c 100644 --- a/docs/reference/tie.html +++ b/docs/reference/tie.html @@ -1,9 +1,9 @@ -Tied notes — tie • tabrTied notes — tie • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -150,15 +150,15 @@

    Tied notes

    Arguments

    -
    x
    + + +
    x

    character, a single chord.

    Value

    - - -

    a character string.

    +

    a character string.

    Details

    @@ -185,15 +185,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/time_format.html b/docs/reference/time_format.html new file mode 100644 index 0000000..8fbea1a --- /dev/null +++ b/docs/reference/time_format.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/to_tabr.html b/docs/reference/to_tabr.html index cb23740..769d043 100644 --- a/docs/reference/to_tabr.html +++ b/docs/reference/to_tabr.html @@ -1,9 +1,9 @@ -Music notation syntax converters — to_tabr • tabrMusic notation syntax converters — to_tabr • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -152,47 +152,47 @@

    Music notation syntax converters

    Arguments

    -
    id
    + + +
    id

    character, suffix of from_* function, e.g., "chorrrds"

    -
    ...
    +
    ...

    arguments passed to the function matched by id.

    -
    x
    +
    x

    character, general syntax input. See details and examples for how inputs are structured for each converter.

    -
    key
    +
    key

    key signature, used to enforce consistent use of flats or sharps.

    -
    guitar
    +
    guitar

    logical, attempt to match input chords to known guitar chords in guitarChords(). Otherwise by default standard piano chords of consecutive pitches covering minimum pitch range are returned.

    -
    gc_args
    +
    gc_args

    named list of additional arguments passed to gc_info(), used when guitar = TRUE.

    -
    accidentals
    +
    accidentals

    character, represent accidentals, "flat" or "sharp".

    -
    output
    +
    output

    character, type of output when multiple options are available.

    Value

    - - -

    noteworthy string for chorrrds; music string or list for music21.

    +

    noteworthy string for chorrrds; music string or list for music21.

    Details

    @@ -201,7 +201,7 @@

    Details

    Syntax converter for chorrrds

    - +

    The input x is a character vector of chords output from the chorrrds package, as shown in the examples. Output is a noteworthy string object.

    @@ -234,7 +234,7 @@

    Syntax converter for chorrrds

    Syntax converter for music21

    - +

    The input x is a character vector of in music21 tiny notation syntax, as shown in the examples. Default output is a music object. Setting @@ -319,15 +319,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tp.html b/docs/reference/tp.html new file mode 100644 index 0000000..9dac9f7 --- /dev/null +++ b/docs/reference/tp.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/track.html b/docs/reference/track.html index 5ebc92a..b0e5cbb 100644 --- a/docs/reference/track.html +++ b/docs/reference/track.html @@ -1,9 +1,9 @@ -Create a music track — track • tabrCreate a music track — track • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -172,45 +172,45 @@

    Create a music track

    Arguments

    -
    phrase
    + + +
    phrase

    a phrase object.

    -
    clef
    +
    clef

    character, include a music staff with the given clef. NA to suppress. See details.

    -
    key
    +
    key

    character, key signature for music staff. See details.

    -
    tab
    +
    tab

    logical, include tablature staff. NA to suppress.

    -
    tuning
    +
    tuning

    character, pitches describing the instrument string tuning or a predefined tuning ID. See tunings(). Defaults to standard guitar tuning; not relevant if tablature staff is suppressed.

    -
    voice
    +
    voice

    integer, ID indicating the unique voice phrase() belongs to within a single track (another track may share the same tab/music staff but have a different voice ID). Up to two voices are supported per track.

    -
    lyrics
    +
    lyrics

    a lyrics object or NA. See details.

    Value

    - - -

    a tibble data frame

    +

    a tibble data frame

    Details

    @@ -279,15 +279,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/track_bass.html b/docs/reference/track_bass.html new file mode 100644 index 0000000..12c74ce --- /dev/null +++ b/docs/reference/track_bass.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/track_bc.html b/docs/reference/track_bc.html new file mode 100644 index 0000000..12c74ce --- /dev/null +++ b/docs/reference/track_bc.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/track_guitar.html b/docs/reference/track_guitar.html new file mode 100644 index 0000000..12c74ce --- /dev/null +++ b/docs/reference/track_guitar.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/track_tc.html b/docs/reference/track_tc.html new file mode 100644 index 0000000..12c74ce --- /dev/null +++ b/docs/reference/track_tc.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/trackbind.html b/docs/reference/trackbind.html index c275662..cad29c1 100644 --- a/docs/reference/trackbind.html +++ b/docs/reference/trackbind.html @@ -1,9 +1,9 @@ -Bind track tables — trackbind • tabrBind track tables — trackbind • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -148,20 +148,20 @@

    Bind track tables

    Arguments

    -
    ...
    + + +
    ...

    single-entry track data frames.

    -
    id
    +
    id

    integer, ID vector indicating distinct tracks corresponding to distinct sheet music staves. See details.

    Value

    - - -

    a tibble data frame

    +

    a tibble data frame

    Details

    @@ -218,15 +218,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/transpose.html b/docs/reference/transpose.html index cdeb82a..5aac493 100644 --- a/docs/reference/transpose.html +++ b/docs/reference/transpose.html @@ -1,9 +1,9 @@ -Transpose pitch — transpose • tabrTranspose pitch — transpose • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -150,34 +150,34 @@

    Transpose pitch

    Arguments

    -
    notes
    + + +
    notes

    character, a noteworthy string.

    -
    n
    +
    n

    integer, positive or negative number of semitones to transpose.

    -
    octaves
    +
    octaves

    NULL or character, "tick" or "integer" octave numbering in result.

    -
    accidentals
    +
    accidentals

    NULL or character, represent accidentals, "flat" or "sharp".

    -
    key
    +
    key

    NULL or character, use a key signature to specify and override accidentals. Ignored if c or am.

    Value

    - - -

    character

    +

    character

    Details

    @@ -243,15 +243,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/triplet.html b/docs/reference/triplet.html new file mode 100644 index 0000000..d9d87c7 --- /dev/null +++ b/docs/reference/triplet.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tuning_intervals.html b/docs/reference/tuning_intervals.html new file mode 100644 index 0000000..34c1ad5 --- /dev/null +++ b/docs/reference/tuning_intervals.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/tunings.html b/docs/reference/tunings.html index 9a4ad65..baca220 100644 --- a/docs/reference/tunings.html +++ b/docs/reference/tunings.html @@ -1,10 +1,10 @@ -Predefined instrument tunings — tunings • tabrPredefined instrument tunings — tunings • tabr - +
    @@ -26,14 +26,14 @@
    - +
    @@ -166,15 +166,15 @@

    Format

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/tuplet.html b/docs/reference/tuplet.html index ff12fd9..8951248 100644 --- a/docs/reference/tuplet.html +++ b/docs/reference/tuplet.html @@ -1,9 +1,9 @@ -Tuplets — tuplet • tabrTuplets — tuplet • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -150,33 +150,33 @@

    Tuplets

    Arguments

    -
    x
    + + +
    x

    noteworthy string or phrase object.

    -
    n
    +
    n

    integer, duration of each tuplet note, e.g., 8 for 8th note tuplet.

    -
    string,
    +
    string,

    character, optional string or vector with same number of timesteps as x that specifies which strings to play for each specific note. Only applies when x is a noteworthy string.

    -
    a
    +
    a

    integer, notes per tuplet.

    -
    b
    +
    b

    integer, beats per tuplet.

    Value

    - - -

    phrase

    +

    phrase

    Details

    @@ -223,15 +223,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/untie.html b/docs/reference/untie.html new file mode 100644 index 0000000..eb31beb --- /dev/null +++ b/docs/reference/untie.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/valid-noteinfo.html b/docs/reference/valid-noteinfo.html index c23a8f0..ee130d0 100644 --- a/docs/reference/valid-noteinfo.html +++ b/docs/reference/valid-noteinfo.html @@ -1,12 +1,12 @@ -Check note info validity — valid-noteinfo • tabrCheck note info validity — valid-noteinfo • tabr - +
    @@ -28,14 +28,14 @@
    - +
    @@ -158,24 +158,24 @@

    Check note info validity

    Arguments

    -
    x
    + + +
    x

    character, a note info string.

    -
    na.rm
    +
    na.rm

    remove NAs.

    -
    format
    +
    format

    NULL or character, the timestep delimiter format, "space" or "vector".

    Value

    - - -

    depends on the function

    +

    depends on the function

    Details

    @@ -230,15 +230,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/valid-notes.html b/docs/reference/valid-notes.html index d4c85e5..70c10d4 100644 --- a/docs/reference/valid-notes.html +++ b/docs/reference/valid-notes.html @@ -1,9 +1,9 @@ -Check note and chord validity — valid-notes • tabrCheck note and chord validity — valid-notes • tabr - +
    @@ -25,14 +25,14 @@
    - +
    @@ -156,34 +156,34 @@

    Check note and chord validity

    Arguments

    -
    x
    + + +
    x

    character, a noteworthy string.

    -
    na.rm
    +
    na.rm

    remove NAs.

    -
    octaves
    +
    octaves

    NULL or character, "tick" or "integer" octave numbering in result.

    -
    accidentals
    +
    accidentals

    NULL or character, represent accidentals, "flat" or "sharp".

    -
    format
    +
    format

    NULL or character, the timestep delimiter format, "space" or "vector".

    Value

    - - -

    depends on the function

    +

    depends on the function

    Details

    @@ -282,15 +282,15 @@

    Examples

    -

    Site built with pkgdown 2.0.7.

    +

    Site built with pkgdown 2.1.0.

    - - + + diff --git a/docs/reference/volta.html b/docs/reference/volta.html new file mode 100644 index 0000000..f2df233 --- /dev/null +++ b/docs/reference/volta.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/x5.html b/docs/reference/x5.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/x5.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/x7.html b/docs/reference/x7.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/x7.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/x7s11.html b/docs/reference/x7s11.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/x7s11.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/x7s5.html b/docs/reference/x7s5.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/x7s5.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/x7s9.html b/docs/reference/x7s9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/x7s9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/x9.html b/docs/reference/x9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/x9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xM7s11.html b/docs/reference/xM7s11.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xM7s11.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/x_11.html b/docs/reference/x_11.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/x_11.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/x_13.html b/docs/reference/x_13.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/x_13.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xadd9.html b/docs/reference/xadd9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xadd9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xaug.html b/docs/reference/xaug.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xaug.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xdim.html b/docs/reference/xdim.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xdim.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xdim7.html b/docs/reference/xdim7.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xdim7.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xm.html b/docs/reference/xm.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xm.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xm11.html b/docs/reference/xm11.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xm11.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xm13.html b/docs/reference/xm13.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xm13.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xm6.html b/docs/reference/xm6.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xm6.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xm7.html b/docs/reference/xm7.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xm7.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xm7b5.html b/docs/reference/xm7b5.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xm7b5.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xm9.html b/docs/reference/xm9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xm9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xma9.html b/docs/reference/xma9.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xma9.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xs2.html b/docs/reference/xs2.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xs2.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/reference/xs4.html b/docs/reference/xs4.html new file mode 100644 index 0000000..5715526 --- /dev/null +++ b/docs/reference/xs4.html @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 998dfe1..edf4337 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -1,342 +1,117 @@ - - - - https://leonawicz.github.io/tabr/404.html - - - https://leonawicz.github.io/tabr/articles/index.html - - - https://leonawicz.github.io/tabr/articles/tabr-basics.html - - - https://leonawicz.github.io/tabr/articles/tabr-chordchart.html - - - https://leonawicz.github.io/tabr/articles/tabr-chords.html - - - https://leonawicz.github.io/tabr/articles/tabr-engraving.html - - - https://leonawicz.github.io/tabr/articles/tabr-ex1.html - - - https://leonawicz.github.io/tabr/articles/tabr-ex2.html - - - https://leonawicz.github.io/tabr/articles/tabr-ex3.html - - - https://leonawicz.github.io/tabr/articles/tabr-ex4.html - - - https://leonawicz.github.io/tabr/articles/tabr-fretboard.html - - - https://leonawicz.github.io/tabr/articles/tabr-helpers.html - - - https://leonawicz.github.io/tabr/articles/tabr-phrases.html - - - https://leonawicz.github.io/tabr/articles/tabr-prog-chords.html - - - https://leonawicz.github.io/tabr/articles/tabr-prog-converters.html - - - https://leonawicz.github.io/tabr/articles/tabr-prog-music.html - - - https://leonawicz.github.io/tabr/articles/tabr-prog-noteinfo.html - - - https://leonawicz.github.io/tabr/articles/tabr-prog-notes.html - - - https://leonawicz.github.io/tabr/articles/tabr-prog-nw.html - - - https://leonawicz.github.io/tabr/articles/tabr-prog-scales.html - - - https://leonawicz.github.io/tabr/articles/tabr-repeats.html - - - https://leonawicz.github.io/tabr/articles/tabr-snippets.html - - - https://leonawicz.github.io/tabr/articles/tabr-tracks-scores.html - - - https://leonawicz.github.io/tabr/articles/tabr-tunings.html - - - https://leonawicz.github.io/tabr/authors.html - - - https://leonawicz.github.io/tabr/CODE_OF_CONDUCT.html - - - https://leonawicz.github.io/tabr/index.html - - - https://leonawicz.github.io/tabr/LICENSE-text.html - - - https://leonawicz.github.io/tabr/LICENSE.html - - - https://leonawicz.github.io/tabr/news/index.html - - - https://leonawicz.github.io/tabr/reference/append_phrases.html - - - https://leonawicz.github.io/tabr/reference/articulations.html - - - https://leonawicz.github.io/tabr/reference/as_music_df.html - - - https://leonawicz.github.io/tabr/reference/chord-compare.html - - - https://leonawicz.github.io/tabr/reference/chord-filter.html - - - https://leonawicz.github.io/tabr/reference/chord-mapping.html - - - https://leonawicz.github.io/tabr/reference/chords.html - - - https://leonawicz.github.io/tabr/reference/chord_arpeggiate.html - - - https://leonawicz.github.io/tabr/reference/chord_break.html - - - https://leonawicz.github.io/tabr/reference/chord_def.html - - - https://leonawicz.github.io/tabr/reference/chord_invert.html - - - https://leonawicz.github.io/tabr/reference/chord_is_major.html - - - https://leonawicz.github.io/tabr/reference/chord_set.html - - - https://leonawicz.github.io/tabr/reference/double-bracket.html - - - https://leonawicz.github.io/tabr/reference/dyad.html - - - https://leonawicz.github.io/tabr/reference/freq_ratio.html - - - https://leonawicz.github.io/tabr/reference/guitarChords.html - - - https://leonawicz.github.io/tabr/reference/hp.html - - - https://leonawicz.github.io/tabr/reference/index.html - - - https://leonawicz.github.io/tabr/reference/intervals.html - - - https://leonawicz.github.io/tabr/reference/interval_semitones.html - - - https://leonawicz.github.io/tabr/reference/is_diatonic.html - - - https://leonawicz.github.io/tabr/reference/keys.html - - - https://leonawicz.github.io/tabr/reference/lilypond.html - - - https://leonawicz.github.io/tabr/reference/lilypond_root.html - - - https://leonawicz.github.io/tabr/reference/lp_chord_id.html - - - https://leonawicz.github.io/tabr/reference/lyrics.html - - - https://leonawicz.github.io/tabr/reference/mainIntervals.html - - - https://leonawicz.github.io/tabr/reference/midily.html - - - https://leonawicz.github.io/tabr/reference/miditab.html - - - https://leonawicz.github.io/tabr/reference/mode-helpers.html - - - https://leonawicz.github.io/tabr/reference/music-helpers.html - - - https://leonawicz.github.io/tabr/reference/music.html - - - https://leonawicz.github.io/tabr/reference/notate.html - - - https://leonawicz.github.io/tabr/reference/note-checks.html - - - https://leonawicz.github.io/tabr/reference/note-coerce.html - - - https://leonawicz.github.io/tabr/reference/note-equivalence.html - - - https://leonawicz.github.io/tabr/reference/note-logic.html - - - https://leonawicz.github.io/tabr/reference/note-metadata.html - - - https://leonawicz.github.io/tabr/reference/note-summaries.html - - - https://leonawicz.github.io/tabr/reference/noteinfo.html - - - https://leonawicz.github.io/tabr/reference/note_ngram.html - - - https://leonawicz.github.io/tabr/reference/note_slice.html - - - https://leonawicz.github.io/tabr/reference/n_measures.html - - - https://leonawicz.github.io/tabr/reference/phrase-checks.html - - - https://leonawicz.github.io/tabr/reference/phrase.html - - - https://leonawicz.github.io/tabr/reference/pitch_freq.html - - - https://leonawicz.github.io/tabr/reference/pitch_seq.html - - - https://leonawicz.github.io/tabr/reference/plot_fretboard.html - - - https://leonawicz.github.io/tabr/reference/plot_music.html - - - https://leonawicz.github.io/tabr/reference/ratio_to_cents.html - - - https://leonawicz.github.io/tabr/reference/read_midi.html - - - https://leonawicz.github.io/tabr/reference/render_chordchart.html - - - https://leonawicz.github.io/tabr/reference/render_music.html - - - https://leonawicz.github.io/tabr/reference/repeats.html - - - https://leonawicz.github.io/tabr/reference/rest.html - - - https://leonawicz.github.io/tabr/reference/scale-deg.html - - - https://leonawicz.github.io/tabr/reference/scale-helpers.html - - - https://leonawicz.github.io/tabr/reference/scale_chords.html - - - https://leonawicz.github.io/tabr/reference/score.html - - - https://leonawicz.github.io/tabr/reference/sf_phrase.html - - - https://leonawicz.github.io/tabr/reference/simplify_phrase.html - - - https://leonawicz.github.io/tabr/reference/single-bracket.html - - - https://leonawicz.github.io/tabr/reference/string_unfold.html - - - https://leonawicz.github.io/tabr/reference/tab.html - - - https://leonawicz.github.io/tabr/reference/tabr-c.html - - - https://leonawicz.github.io/tabr/reference/tabr-head.html - - - https://leonawicz.github.io/tabr/reference/tabr-length.html - - - https://leonawicz.github.io/tabr/reference/tabr-methods.html - - - https://leonawicz.github.io/tabr/reference/tabr-rep.html - - - https://leonawicz.github.io/tabr/reference/tabr-rev.html - - - https://leonawicz.github.io/tabr/reference/tabr.html - - - https://leonawicz.github.io/tabr/reference/tabrSyntax.html - - - https://leonawicz.github.io/tabr/reference/tabr_options.html - - - https://leonawicz.github.io/tabr/reference/tie.html - - - https://leonawicz.github.io/tabr/reference/to_tabr.html - - - https://leonawicz.github.io/tabr/reference/track.html - - - https://leonawicz.github.io/tabr/reference/trackbind.html - - - https://leonawicz.github.io/tabr/reference/transpose.html - - - https://leonawicz.github.io/tabr/reference/tunings.html - - - https://leonawicz.github.io/tabr/reference/tuplet.html - - - https://leonawicz.github.io/tabr/reference/valid-noteinfo.html - - - https://leonawicz.github.io/tabr/reference/valid-notes.html - + +https://leonawicz.github.io/tabr/404.html +https://leonawicz.github.io/tabr/articles/index.html +https://leonawicz.github.io/tabr/articles/tabr-basics.html +https://leonawicz.github.io/tabr/articles/tabr-chordchart.html +https://leonawicz.github.io/tabr/articles/tabr-chords.html +https://leonawicz.github.io/tabr/articles/tabr-engraving.html +https://leonawicz.github.io/tabr/articles/tabr-ex1.html +https://leonawicz.github.io/tabr/articles/tabr-ex2.html +https://leonawicz.github.io/tabr/articles/tabr-ex3.html +https://leonawicz.github.io/tabr/articles/tabr-ex4.html +https://leonawicz.github.io/tabr/articles/tabr-fretboard.html +https://leonawicz.github.io/tabr/articles/tabr-helpers.html +https://leonawicz.github.io/tabr/articles/tabr-phrases.html +https://leonawicz.github.io/tabr/articles/tabr-prog-chords.html +https://leonawicz.github.io/tabr/articles/tabr-prog-converters.html +https://leonawicz.github.io/tabr/articles/tabr-prog-music.html +https://leonawicz.github.io/tabr/articles/tabr-prog-noteinfo.html +https://leonawicz.github.io/tabr/articles/tabr-prog-notes.html +https://leonawicz.github.io/tabr/articles/tabr-prog-nw.html +https://leonawicz.github.io/tabr/articles/tabr-prog-scales.html +https://leonawicz.github.io/tabr/articles/tabr-repeats.html +https://leonawicz.github.io/tabr/articles/tabr-snippets.html +https://leonawicz.github.io/tabr/articles/tabr-tracks-scores.html +https://leonawicz.github.io/tabr/articles/tabr-tunings.html +https://leonawicz.github.io/tabr/authors.html +https://leonawicz.github.io/tabr/CODE_OF_CONDUCT.html +https://leonawicz.github.io/tabr/index.html +https://leonawicz.github.io/tabr/LICENSE-text.html +https://leonawicz.github.io/tabr/LICENSE.html +https://leonawicz.github.io/tabr/news/index.html +https://leonawicz.github.io/tabr/reference/append_phrases.html +https://leonawicz.github.io/tabr/reference/articulations.html +https://leonawicz.github.io/tabr/reference/as_music_df.html +https://leonawicz.github.io/tabr/reference/chord-compare.html +https://leonawicz.github.io/tabr/reference/chord-filter.html +https://leonawicz.github.io/tabr/reference/chord-mapping.html +https://leonawicz.github.io/tabr/reference/chords.html +https://leonawicz.github.io/tabr/reference/chord_arpeggiate.html +https://leonawicz.github.io/tabr/reference/chord_break.html +https://leonawicz.github.io/tabr/reference/chord_def.html +https://leonawicz.github.io/tabr/reference/chord_invert.html +https://leonawicz.github.io/tabr/reference/chord_is_major.html +https://leonawicz.github.io/tabr/reference/chord_set.html +https://leonawicz.github.io/tabr/reference/double-bracket.html +https://leonawicz.github.io/tabr/reference/dyad.html +https://leonawicz.github.io/tabr/reference/freq_ratio.html +https://leonawicz.github.io/tabr/reference/guitarChords.html +https://leonawicz.github.io/tabr/reference/hp.html +https://leonawicz.github.io/tabr/reference/index.html +https://leonawicz.github.io/tabr/reference/intervals.html +https://leonawicz.github.io/tabr/reference/interval_semitones.html +https://leonawicz.github.io/tabr/reference/is_diatonic.html +https://leonawicz.github.io/tabr/reference/keys.html +https://leonawicz.github.io/tabr/reference/lilypond.html +https://leonawicz.github.io/tabr/reference/lilypond_root.html +https://leonawicz.github.io/tabr/reference/lp_chord_id.html +https://leonawicz.github.io/tabr/reference/lyrics.html +https://leonawicz.github.io/tabr/reference/mainIntervals.html +https://leonawicz.github.io/tabr/reference/midily.html +https://leonawicz.github.io/tabr/reference/miditab.html +https://leonawicz.github.io/tabr/reference/mode-helpers.html +https://leonawicz.github.io/tabr/reference/music-helpers.html +https://leonawicz.github.io/tabr/reference/music.html +https://leonawicz.github.io/tabr/reference/notate.html +https://leonawicz.github.io/tabr/reference/note-checks.html +https://leonawicz.github.io/tabr/reference/note-coerce.html +https://leonawicz.github.io/tabr/reference/note-equivalence.html +https://leonawicz.github.io/tabr/reference/note-logic.html +https://leonawicz.github.io/tabr/reference/note-metadata.html +https://leonawicz.github.io/tabr/reference/note-summaries.html +https://leonawicz.github.io/tabr/reference/noteinfo.html +https://leonawicz.github.io/tabr/reference/note_ngram.html +https://leonawicz.github.io/tabr/reference/note_slice.html +https://leonawicz.github.io/tabr/reference/n_measures.html +https://leonawicz.github.io/tabr/reference/phrase-checks.html +https://leonawicz.github.io/tabr/reference/phrase.html +https://leonawicz.github.io/tabr/reference/pitch_freq.html +https://leonawicz.github.io/tabr/reference/pitch_seq.html +https://leonawicz.github.io/tabr/reference/plot_fretboard.html +https://leonawicz.github.io/tabr/reference/plot_music.html +https://leonawicz.github.io/tabr/reference/ratio_to_cents.html +https://leonawicz.github.io/tabr/reference/read_midi.html +https://leonawicz.github.io/tabr/reference/render_chordchart.html +https://leonawicz.github.io/tabr/reference/render_music.html +https://leonawicz.github.io/tabr/reference/repeats.html +https://leonawicz.github.io/tabr/reference/rest.html +https://leonawicz.github.io/tabr/reference/scale-deg.html +https://leonawicz.github.io/tabr/reference/scale-helpers.html +https://leonawicz.github.io/tabr/reference/scale_chords.html +https://leonawicz.github.io/tabr/reference/score.html +https://leonawicz.github.io/tabr/reference/sf_phrase.html +https://leonawicz.github.io/tabr/reference/simplify_phrase.html +https://leonawicz.github.io/tabr/reference/single-bracket.html +https://leonawicz.github.io/tabr/reference/string_unfold.html +https://leonawicz.github.io/tabr/reference/tab.html +https://leonawicz.github.io/tabr/reference/tabr-c.html +https://leonawicz.github.io/tabr/reference/tabr-details.html +https://leonawicz.github.io/tabr/reference/tabr-head.html +https://leonawicz.github.io/tabr/reference/tabr-length.html +https://leonawicz.github.io/tabr/reference/tabr-methods.html +https://leonawicz.github.io/tabr/reference/tabr-rep.html +https://leonawicz.github.io/tabr/reference/tabr-rev.html +https://leonawicz.github.io/tabr/reference/tabr.html +https://leonawicz.github.io/tabr/reference/tabrSyntax.html +https://leonawicz.github.io/tabr/reference/tabr_options.html +https://leonawicz.github.io/tabr/reference/tie.html +https://leonawicz.github.io/tabr/reference/to_tabr.html +https://leonawicz.github.io/tabr/reference/track.html +https://leonawicz.github.io/tabr/reference/trackbind.html +https://leonawicz.github.io/tabr/reference/transpose.html +https://leonawicz.github.io/tabr/reference/tunings.html +https://leonawicz.github.io/tabr/reference/tuplet.html +https://leonawicz.github.io/tabr/reference/valid-noteinfo.html +https://leonawicz.github.io/tabr/reference/valid-notes.html + diff --git a/man/tabr-details.Rd b/man/tabr-details.Rd new file mode 100644 index 0000000..ab267bf --- /dev/null +++ b/man/tabr-details.Rd @@ -0,0 +1,51 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/tabr.R +\name{tabr-details} +\alias{tabr-details} +\title{tabr: Additional Detals} +\description{ +The \code{tabr} package provides a music notation syntax and a collection of music +programming functions for generating, manipulating, organizing and analyzing +musical information in R. The music notation framework facilitates creating +and analyzing music data in notation form. +} +\details{ +Music syntax can be entered directly in character strings, for example to +quickly transcribe short pieces of music. The package contains functions for +directly performing various mathematical, logical and organizational +operations and musical transformations on special object classes that +facilitate working with music data and notation. The same music data can be +organized in tidy data frames for a familiar and powerful approach to the +analysis of large amounts of structured music data. Functions are available +for mapping seamlessly between these formats and their representations of +musical information. + +The package also provides an API to 'LilyPond' (\url{https://lilypond.org/}) for +transcribing musical representations in R into tablature ("tabs") and sheet +music. 'LilyPond' is open source music engraving software for generating high +quality sheet music based on markup syntax. The package generates 'LilyPond' +files from R code and can pass them to the 'LilyPond' command line interface +to be rendered into sheet music PDF files or inserted into R markdown +documents. + +The package offers nominal MIDI file output support in conjunction with +rendering sheet music. The package can read MIDI files and attempts to +structure the MIDI data to integrate as best as possible with the data +structures and functionality found throughout the package. + +\code{tabr} offers a useful but limited LilyPond API and is not intended to +access all LilyPond functionality from R, +nor is transcription via the API the entire scope of \code{tabr}. +If you are only creating sheet music on a case by case basis, write your own +LilyPond files manually. +There is no need to use \code{tabr} or limit yourself to its existing +LilyPond API. +If you are generating music notation programmatically, +\code{tabr} provides the ability to do so in R and has the added benefit of +converting what you write in R code to the LilyPond file format to be +rendered as printable guitar tablature. + +While LilyPond is listed as a system requirement for \code{tabr}, you can +use the package for music analysis without installing LilyPond if you do not +intend to render tabs. +} diff --git a/man/tabr.Rd b/man/tabr.Rd index bfaca0d..6605a0e 100644 --- a/man/tabr.Rd +++ b/man/tabr.Rd @@ -2,52 +2,23 @@ % Please edit documentation in R/tabr.R \docType{package} \name{tabr} -\alias{tabr} \alias{tabr-package} -\title{tabr: Music notation syntax, manipulation, analysis and transcription in R.} +\alias{tabr} +\title{tabr: Music Notation Syntax, Manipulation, Analysis and Transcription in R} \description{ -The \code{tabr} package provides a music notation syntax and a collection of music -programming functions for generating, manipulating, organizing and analyzing -musical information in R. The music notation framework facilitates creating -and analyzing music data in notation form. -} -\details{ -Music syntax can be entered directly in character strings, for example to -quickly transcribe short pieces of music. The package contains functions for -directly performing various mathematical, logical and organizational -operations and musical transformations on special object classes that -facilitate working with music data and notation. The same music data can be -organized in tidy data frames for a familiar and powerful approach to the -analysis of large amounts of structured music data. Functions are available -for mapping seamlessly between these formats and their representations of -musical information. - -The package also provides an API to 'LilyPond' (\url{https://lilypond.org/}) for -transcribing musical representations in R into tablature ("tabs") and sheet -music. 'LilyPond' is open source music engraving software for generating high -quality sheet music based on markup syntax. The package generates 'LilyPond' -files from R code and can pass them to the 'LilyPond' command line interface -to be rendered into sheet music PDF files or inserted into R markdown -documents. +\if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}} -The package offers nominal MIDI file output support in conjunction with -rendering sheet music. The package can read MIDI files and attempts to -structure the MIDI data to integrate as best as possible with the data -structures and functionality found throughout the package. +Provides a music notation syntax and a collection of music programming functions for generating, manipulating, organizing, and analyzing musical information in R. Music syntax can be entered directly in character strings, for example to quickly transcribe short pieces of music. The package contains functions for directly performing various mathematical, logical and organizational operations and musical transformations on special object classes that facilitate working with music data and notation. The same music data can be organized in tidy data frames for a familiar and powerful approach to the analysis of large amounts of structured music data. Functions are available for mapping seamlessly between these formats and their representations of musical information. The package also provides an API to 'LilyPond' (\url{https://lilypond.org/}) for transcribing musical representations in R into tablature ("tabs") and sheet music. 'LilyPond' is open source music engraving software for generating high quality sheet music based on markup syntax. The package generates 'LilyPond' files from R code and can pass them to the 'LilyPond' command line interface to be rendered into sheet music PDF files or inserted into R markdown documents. The package offers nominal MIDI file output support in conjunction with rendering sheet music. The package can read MIDI files and attempts to structure the MIDI data to integrate as best as possible with the data structures and functionality found throughout the package. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://github.com/leonawicz/tabr} + \item Report bugs at \url{https://github.com/leonawicz/tabr/issues} +} -\code{tabr} offers a useful but limited LilyPond API and is not intended to -access all LilyPond functionality from R, -nor is transcription via the API the entire scope of \code{tabr}. -If you are only creating sheet music on a case by case basis, write your own -LilyPond files manually. -There is no need to use \code{tabr} or limit yourself to its existing -LilyPond API. -If you are generating music notation programmatically, -\code{tabr} provides the ability to do so in R and has the added benefit of -converting what you write in R code to the LilyPond file format to be -rendered as printable guitar tablature. +} +\author{ +\strong{Maintainer}: Matthew Leonawicz \email{rpkgs@pm.me} (\href{https://orcid.org/0000-0001-9452-2771}{ORCID}) -While LilyPond is listed as a system requirement for \code{tabr}, you can -use the package for music analysis without installing LilyPond if you do not -intend to render tabs. } diff --git a/pkgdown/_pkgdown.yml b/pkgdown/_pkgdown.yml index 044f0cf..4bc2093 100644 --- a/pkgdown/_pkgdown.yml +++ b/pkgdown/_pkgdown.yml @@ -12,6 +12,7 @@ reference: - title: Package contents: - tabr + - tabr-details - title: Class methods desc: "S3 methods implemented for tabr classes" contents: diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png index 61b24e0..40c7d7a 100644 Binary files a/pkgdown/favicon/apple-touch-icon-120x120.png and b/pkgdown/favicon/apple-touch-icon-120x120.png differ diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png index e520295..c2bfcfe 100644 Binary files a/pkgdown/favicon/apple-touch-icon-152x152.png and b/pkgdown/favicon/apple-touch-icon-152x152.png differ diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png index 28978ba..d78540d 100644 Binary files a/pkgdown/favicon/apple-touch-icon-180x180.png and b/pkgdown/favicon/apple-touch-icon-180x180.png differ diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png index eb12813..6f456c9 100644 Binary files a/pkgdown/favicon/apple-touch-icon-60x60.png and b/pkgdown/favicon/apple-touch-icon-60x60.png differ diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png index 957bdc7..94cf50d 100644 Binary files a/pkgdown/favicon/apple-touch-icon-76x76.png and b/pkgdown/favicon/apple-touch-icon-76x76.png differ diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png index 70f26d0..605b7cc 100644 Binary files a/pkgdown/favicon/apple-touch-icon.png and b/pkgdown/favicon/apple-touch-icon.png differ diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png index cd2cb46..33f04b1 100644 Binary files a/pkgdown/favicon/favicon-16x16.png and b/pkgdown/favicon/favicon-16x16.png differ diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png index 346be77..c477b2d 100644 Binary files a/pkgdown/favicon/favicon-32x32.png and b/pkgdown/favicon/favicon-32x32.png differ diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico index f6450ab..6438f01 100644 Binary files a/pkgdown/favicon/favicon.ico and b/pkgdown/favicon/favicon.ico differ