collapseHumdrum: "Collapse" humdrumR data into a field

In Computational-Cognitive-Musicology-Lab/humdrumR: humdrumR

"Collapse" humdrumR data into a field

Description

collapseHumdrum allows you collapse a data field across across groups within the data indicated by the by argument. Data is "collapsed" either by pasting the data into a string, or by putting them into list. collapseStops, collapsePaths, and collapseRecords are built-in calls to collapseHumtab, with some additional optimizations.

Usage

collapseHumdrum(
  humdrumR,
  by,
  fields = selectedFields(humdrumR),
  dataTypes = "GLIMDd",
  collapseAtomic = TRUE,
  sep = " "
)

collapseStops(
  humdrumR,
  fields = selectedFields(humdrumR),
  collapseAtomic = TRUE,
  sep = " "
)

collapsePaths(
  humdrumR,
  fields = selectedFields(humdrumR),
  collapseAtomic = TRUE,
  sep = " "
)

collapseRecords(
  humdrumR,
  fields = selectedFields(humdrumR),
  collapseAtomic = TRUE,
  sep = " "
)

Arguments

humdrumR	HumdrumR data. Must be a humdrumR data object.
by	Fields to collapse data within. Must be character. Must be character strings partially matching the name(s) of a field(s) in the humdrumR input. Data in the fields will be collapsed within these fields.
fields	The target field(s) in the humdrumR data to collapse. Defaults to selectedFields(humdrumR). Must be character strings partially matching the name(s) of a data field(s) in the humdrumR input.
dataTypes	Which types of humdrum record(s) to collapse. Defaults to "GLIMDd". Must be character. Legal values are ⁠'G', 'L', 'I', 'M', 'D', 'd'⁠ or any combination of these (e.g., "LIM"). (See the humdrum table documentation Fields section for explanation.)
collapseAtomic	Whether to collapse the data into character strings. Defaults to TRUE. Must be a singleton logical value: an on/off switch. If TRUE, data is collapsed into a single character string. If FALSE, data is conctanated in a list.
sep	A separator for collapsed strings. Defaults to " " (space). Must be a single character string. Only has an effect if collapseAtomic == TRUE.

See Also

The humdrum folding functions serve a similar function, "folding" data into new fields, rather than collapsing it within a field.

Other Humdrum table reshaping functions: cleave(), expandPaths(), rend()

Computational-Cognitive-Musicology-Lab/humdrumR documentation built on Oct. 22, 2024, 9:28 a.m.