census: Tabulate records and tokens in a humdrumR corpus

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

Tabulate records and tokens in a humdrumR corpus

Description

census tabulates the raw "size" of a humdrumR corpus, including the total number of records and tokens. census is one of humdrumR's basic corpus summary functions.

Usage

census(
  humdrumR,
  dataTypes = "GLIMDd",
  by = Piece,
  removeEmpty = FALSE,
  drop = FALSE
)

census(humdata)[i]

## S3 method for class 'humCensus'
print(censusTable, showEach = TRUE, screenWidth = options("width")$width - 10L)

Arguments

humdrumR	HumdrumR data. Must be a humdrumR data object.
dataTypes	Which types of humdrum records to include in the census. 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.).
by	An arbitrary expression which indicates how to group the data. Defaults to Piece (a humdrumR data field).
removeEmpty	Whether to include zero tokens. Defaults to FALSE Must be a singleton logical value: an on/off switch. If set TRUE, any groups that have zero tokens are not included in the humCensus table.
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 the "by-group" names.

Details

census returns a special data.frame called a humCensus table. A humCensus table has five columns of information:

1. Records

   • The total number of records.

2. Tokens

   • The total number of tokens.

3. (unique)

   • The number of unique tokens

4. Characters

   • The total number of characters. (This includes humdrum control characters like * and ⁠!!⁠.)

5. (per token)

   • This is simply Characters / Tokens, indicating the mean length of each token.

By default, census tabulates data within pieces in the corpus, with each piece tabulated in a row of the humCensus table. Rows are labeled with each file name. When a humCensus object is printed, the totals across all pieces are printed as well—(unique) and (per token) values are calculated across all pieces as well, not summed. The by argument can be used to tabulate data across other divisions in the data (see next section).

Tabulate "by" other groups

The by argument to census indicates groupings in the data to tabulate within, grouping across pieces in the corpus by default. by can be an arbitrary expression which is evaluated inside the humdrum table, like the groupby argument to a with/within call. The by expression must be the full length of the humdrum table.

See Also

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

Examples

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

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