spines: Summarize spines in humdrum dataset.

spinesR Documentation

Summarize spines in humdrum dataset.

Description

spines tabulates the spines and spine paths within the files in a humdrumR corpus. spines is one of humdrumR's basic corpus summary functions.

Usage

spines(humdrumR, drop = FALSE)

## S3 method for class 'humSpines'
spineTable[i, drop = FALSE]

## S3 method for class 'humSpines'
print(spineTable, showEach = TRUE)

Arguments

humdrumR

HumdrumR data to summarize.

Must be a humdrumR data object.

drop

Whether to return normal data.table or a humCensus table.

Defaults to FALSE.

Must be a singleton logical value: an on/off switch.

If drop = TRUE, a normal data.table is returned instead of a humCensus table.

i

Index for rows.

If numeric, selects rows by index. If character, the string is matched as a regular expression against filenames in the corpus.

Details

spines returns a special data.frame called a humSpines table. A humSpines table has five columns of information about each piece:

  1. Spines

    • The number of spines.

  2. Paths

    • The total number of spine paths.

  3. In

    • The number of spines which contain any spine paths.

  4. *^

    • The total number of spine splits ("*^").

  5. *v

    • The total number of spine joins ("*v").

When humSpine table prints on the command line, "tallies" of the unique combinations of spines and paths in the files are also printed.

See Also

Other corpus summary functions: census(), humSummary, interpretations(), reference()

Examples

chorales <- readHumdrum(humdrumRroot, "HumdrumData/BachChorales/*.krn")
spines(chorales)


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