proc_by_module: Process ACE/SEA data by module

View source: R/module-proc.R

proc_by_moduleR Documentation

Process ACE/SEA data by module

Description

Applies corresponding ace_procs to every unique module.

Usage

proc_by_module(
  df,
  app_type = c("classroom", "explorer", "sea"),
  modules = "all",
  output = "wide",
  conditions = NULL,
  verbose = TRUE
)

Arguments

df

a data.frame containing formatted trialwise ACE data.

This includes data loaded with the following methods:

  1. load_ace_file

  2. load_ace_bulk

app_type

character. What app type produced this data? One of c("classroom", "explorer", "sea"). Must be specified.

modules

character vector. Specify the names of modules (proper naming convention!) to output data for. Defaults to all modules detected in data.

output

string indicating preferred output format. Can be "wide" (default), where one dataframe is output containing cols with data from all modules, or "long", where a dataframe is output, with a list-column containing dataframes with each module's data.

conditions

character vector. If data contains multiple study conditions (e.g. pre & post), specify their labels here. Case insensitive.

verbose

logical. Print details? Defaults to FALSE.

Value

Returns summary statistics for every unique module included in the data as a list. Throws warnings for modules with undefined methods. See ace_procs for a list of supported modules.

Assumptions

Assumes the column module exists in the data.frame.


josegallegos07/aceR documentation built on June 27, 2022, 10:25 a.m.