_pkgdown.yml

url: https://humdrumR.ccml.gtcmt.gatech.edu
home: 
  sidebar:
    structure: [links, license, community, citation, authors, dev, toc]
  links:
  - text: R language official website
    href: https://www.r-project.org
  - text: Humdrum website
    href: https://www.humdrum.org/
  - text: Computational and Cognitive Musicology Lab
    href: https://ccml.gtcmt.gatech.edu/
  - text: Georgia Tech Center for Music Technology
    href: https://gtcmt.gatech.edu/
navbar:
  structure: 
    left: [news, reference, articles, GUI]
    right: [github, search]
  components:
    news:
      text: News
      href: news/index.html
    GUI:
      text: GUI
      href: https://ccml.music.gatech.edu/humdrumR
template:
  includes:
    before_title: <a href="https://gatech.edu"><img src="gt-logo.svg" alt="Georgia Tech" style="height:50px; padding-right:20px;"/></a> <a href="https://ccml.gtcmt.gatech.edu"><img src="CCMLbanner.png" alt="CCMLab" style="height:80px; padding-right:20px;"/></a>
  bootstrap: 5
  bootswatch: flatly
articles:
- title: Basics
  navbar: Basics
  contents:
  - GettingStarted
  - DataFields
- title: Background
  desc: Background info on humdrum and R
  navbar: R/Background
  contents:
  - HumdrumSyntax
  - RPrimer
- title: Preparing data
  desc: Getting your data ready for analysis
  navbar: Data prep
  contents: 
  - ReadWrite
  - ComplexSyntax
  - Reshaping
  - Filtering
- title: Analysis
  desc: Tools for analysis
  navbar: Analysis
  contents:
  - Summary
  - Grouping
  - Context
- title: Musical Processing
  desc: Functionality for analyzing musical information
  navbar: Musical tools
  contents:
  - PitchAndTonality
  - RhythmAndMeter
  - KeysAndChord
reference:
- title: "Reading and Summarizing Data"
  desc: "These tools allow you to import, validate, and abstractly summarize the content of humdrum data."
- subtitle: "Reading and Writing"
  contents:
  - validateHumdrum
  - readHumdrum
  - writeHumdrum
- subtitle: "Summarizing"
  contents:
  - humSummary
  - census
  - interpretations
  - reference
  - spines
- title: "Working with Data"
  desc: >
    These pages describe tools used to manipulate the musical data ensconced within humdrumR data structures.
  contents:
  - token
- subtitle: "Manipulating Humdrum Data"
  contents:
  - withinHumdrum
  - subset.humdrumR
  - indexHumdrum
  - groupHumdrum
  - context
- title: "Musical Tools"
  desc: >
    These pages describe the classes and functions that directly represent or engage musical/music-theoretic concepts.
- subtitle: "Pitch overviews"
  desc: "These pages overview general concepts in humdrumR pitch:"
  contents:
  - humdrumPitch
  - pitchFunctions
  - pitchParsing
  - pitchDeparsing
  - chordFunctions
  - chordParsing
  - chordDeparsing
  - keyFunctions
  - keyParsing
  - keyDeparsing
  - tonalIntervalS4
  - tertianSetS4
  - diatonicSetS4
- subtitle: "Pitch functions"
  desc: "These functions translate between pitch representations:"
  contents:
  - pitch
  - degree
  - interval
  - kern
  - solfa
  - solfg
  - lilypond
  - helmholtz
  - tonh
  - octave
  - step
  - accidental
  - quality
  - bhatk
  - semits
  - midi
  - pc
  - cents
  - freq
  - LO5th
  - transpose
  - invert
  - int
  - mint
  - hint
  - is.simple
  - is.generic
  - gamut
- subtitle: "Key and chord functions"
  desc: "These functions translate between diatonic and tertian representations:"
  contents:
  - romanNumerals
  - key
  - signature
  - romanKey
  - harm
  - chord
  - tertian
  - figuredBass
  - is.major
  - is.minor
  - sonority
- subtitle: "Rhythm overviews"
  desc: "These pages overview general concepts in humdrumR pitch:"
  contents:
  - rhythmFunctions
  - rhythmParsing
  - rhythmDeparsing
  - humMeter
- subtitle: "Duration and Time functions"
  desc: "These functions translate between rhythm representations:"
  contents:
  - bpm2sec
  - recip
  - duration
  - grid
  - notehead
  - seconds
  - ioi
  - sumTies
  - timeline
  - timebase
  - recordDuration
- subtitle: "Beats and Meter"
  desc: "Rhythm and meter analysis functions."
  contents:
  - meter
  - duple
  - tactus
  - nbeats
  - tatum
  - timecount
  - metlev
  - syncopation
- subtitle: "Lyrics"
  desc: "Lyrics and text functions."
  contents:
  - wort
- title: "Data Structures"
  desc: >
    These pages describe the data structures of humdrumR, and how to query or manipulate them.
  contents:
  - humdrumRclass
  - tandem
  - pullHumdrum
  - selectedFields
  - humCoercion
  - humMerge
  - collapseHumdrum
  - expandPaths
  - cleave
  - rend
  - combineFields
  - cleaveGraceNotes
  - unfoldStops
  - humSize
  - humTable
  - struct
- title: "Other Functions"
  desc: "Other useful tools."
- contents: 
  - draw
  - distributions
- subtitle: "Information theory"
  contents:
  - pdist
  - entropy
  - mutualInfo
- subtitle: "Numeric values"
  contents:
  - rational
  - expand
- subtitle: "Manipulating Vectors"
  contents:
  - delta
  - ditto
  - lag
  - segments
  - sigma
  - hop
  - enum
- subtitle: "Regular Expressions"
  desc: >
     [Regular Expressions](https://en.wikipedia.org/wiki/Regular_expression) are essential tools for working with humdrum data.
     These functions provide functionality for working with regular expressions.
  contents:
  - RegexFind
  - humdrumDispatch
  - regexConstruction
  - REparser
- subtitle: "Miscallaneus"
  contents:
  - humdrumRroot
  - partialMatching
- title: "Some R basics lessons"
  desc: >
     Concise descriptions of some important concepts in R coding.
  contents:
  - evaluatingExpressions
  - groupingFactors
  - partialMatching
  - recycling
  - vectorization