proc_ace_complete: Read, Load, and Process all ACE csv files in a directory

proc_ace_completeR Documentation

Read, Load, and Process all ACE csv files in a directory

Description

Overarching wrapper function to read & parse all ACE csv files in a directory.

Usage

proc_ace_complete(
  path_in,
  path_out = paste(path_in, "..", sep = "/"),
  verbose = TRUE,
  data_type = c("explorer", "email", "pulvinar"),
  rt_cutoff_min = 200,
  post_min_trials = 5,
  post_chance_level = "overall",
  post_metric_names = c("BRT.rt_mean.correct", "SAATIMPULSIVE.rt_mean.correct",
    "SAATSUSTAINED.rt_mean.correct", "TNT.rt_mean.correct", "object_count_span.overall",
    "FILTER.k", "COLORSELECTION.max_delay_time.correct.strict", "rcs.overall"),
  post_metric_names_exclude = c("FILTER.rcs", "TNT.rt_mean.correct.")
)

Arguments

path_in

character. A valid path to a folder containing exclusively raw ACE data.

path_out

character. A valid path to a folder containing exclusively raw ACE data. Defaults to to path_in/.., such that the output data will be written to the enclosing folder containing the path_in folder. By default, this keeps the summary data separate from the subfolder containing the raw data, but you can specify the output path to whatever you choose (including identical to the input path). Set this to NULL to process data without writing out a CSV.

verbose

logical. Print details? Defaults to TRUE.

data_type

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

rt_cutoff_min

numeric. Remove within-subject RTs below (but not equal to) this specified value (in ms)? Defaults to 200. Can be set to NA, where no too-low values will be scrubbed. Note that load_ace_bulk already removes RTs below 150 ms for all modules, so those can never be included even if this minimum cutoff is set to a value below 150 ms. Passed through to trim_rt_trials_range.

post_min_trials

Minimum number of trials to require in most restrictive condition. Defaults to 5. This condition is checked against the *_count summary columns, that count all trials with a valid response time (and all no-go trials, if a response was not expected.) Passed through to post_clean_low_trials. Set this argument to NA to leave all trials in and skip this step.

post_chance_level

character. How strictly to retain records containing above-threshold performance? One of:

  • "overall": Trim based on whole-module accuracy. Minimum of: d' > 0, 2-choice task accuracy > 0.5, 4-choice task accuracy > 0.25. Default.

  • "easy": Trim based on within-condition accuracy. Minimum of: d' > 0, 2-choice task accuracy > 0.5, 4-choice task accuracy > 0.25.

  • "none": Do not trim any records by performance threshold.

Passed through to post_clean_chance.

post_metric_names

a character vector containing partial names of metric columns to include in the processed output. All column names containing any of the inputs will be included in output. Passed through to post_reduce_cols.

post_metric_names_exclude

a character vector containing partial names of metric columns to exclude from the processed output. All column names containing any of the inputs will be excluded from output. Passed through to post_reduce_cols.

Value

Returns a tibble containing a cleaned selection of summary statistics from every module in the data.


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