rock (version 0.8.1)

collapse_occurrences: Collapse the occurrences in utterances into groups

Description

This function collapses all occurrences into groups sharing the same identifier, by default the stanzaId identifier ([[sid=..]]).

Usage

collapse_occurrences(
  parsedSource,
  collapseBy = "stanzaId",
  columns = NULL,
  logical = FALSE
)

Value

A dataframe with one row for each value of of collapseBy and columns for collapseBy and each of the columns, with in the cells the counts (if logical is FALSE) or TRUE or FALSE (if logical is TRUE).

Arguments

parsedSource

The parsed sources as provided by parse_source().

collapseBy

The column in the sourceDf (in the parsedSource object) to collapse by (i.e. the column specifying the groups to collapse).

columns

The columns to collapse; if unspecified (i.e. NULL), all codes stored in the code object in the codings object in the parsedSource object are taken (i.e. all used codes in the parsedSource object).

logical

Whether to return the counts of the occurrences (FALSE) or simply whether any code occurreded in the group at all (TRUE).

Examples

### Get path to example source
exampleFile <-
  system.file("extdata", "example-1.rock", package="rock");

### Parse example source
parsedExample <-
  rock::parse_source(exampleFile);

### Collapse logically, using a code (either occurring or not):
collapsedExample <-
  rock::collapse_occurrences(parsedExample,
                             collapseBy = 'childCode1');

### Show result: only two rows left after collapsing,
### because 'childCode1' is either 0 or 1:
collapsedExample;

### Collapse using weights (i.e. count codes in each segment):
collapsedExample <-
  rock::collapse_occurrences(parsedExample,
                             collapseBy = 'childCode1',
                             logical=FALSE);