break_by_category: Breaks the data on specified column

View source: R/all_digit_test_helper_functions.R

break_by_categoryR Documentation

Breaks the data on specified column

Description

Breaks the data on specified column

Usage

break_by_category(data, break_out, break_out_grouping)

Arguments

data

A dataframe, preferably 'cleaned' slot for DigitAnalysis object any parsed version of it

break_out
  • The data column (non-numeric!) to split up the dataset based on different categories in the column if specified as an character.

  • The first division (usually x-axis) shown in plots.

  • Default to NA.

break_out_grouping

A list of arrays, or defaulted to NA. Only effective if break_out is not NA.

  • Each the names of the elements in the list is the break_out name

  • Each array contains the values belonging to that break_out

  • If it is remain as NA as default, while break_out is not NA, then break_out_grouping will default to every individual item in break_out will be in a separate group.

Value

A list of array of indexes in data that belongs to each category


jlederluis/digitanalysis documentation built on Nov. 5, 2023, 11:46 a.m.