get_summary_statistics: Obtain summary statistics of response error

View source: R/analysing.R

get_summary_statisticsR Documentation

Obtain summary statistics of response error

Description

Returns participant-level summary statistic data of response error estimates ready for inferential analysis. Note that the function does not actually conduct the analysis.

Usage

get_summary_statistics(
  data,
  unit = "degrees",
  id_var = "id",
  response_var = "response",
  target_var = "target",
  set_size_var = NULL,
  condition_var = NULL
)

Arguments

data

A data frame with columns containing: participant identifier (declared via variable 'id_var'); the participants' response per trial ('response_var'); the target value ('target_var'); and, if applicable, the set size of each response ('set_size_var'), and the condition of each response ('condition_var').

unit

The unit of measurement in the data frame: "degrees" (measurement is in degrees, from 0 to 360); "degrees_180 (measurement is in degrees, but limited to 0 to 180); or "radians" (measurement is in radians, from pi to 2 * pi, but could also be already in -pi to pi).

id_var

The quoted column name coding for participant id. If the data is from a single participant (i.e., there is no id column) set to NULL.

response_var

The quoted column name coding for the participants' responses

target_var

The quoted column name coding for the target value.

set_size_var

The quoted column name (if applicable) coding for the set size of each response.

condition_var

The quoted column name (if applicable) coding for the condition of each response.

Value

Returns a data frame containing the summary statistics mean_absolute_error, resultant_vector_length, precision, and bias per participant (if applicable), set-size (if applicable), and condition (if applicable).

Examples

# load an example data frame
data(bays2009_full)

# calculate the summary statistics per condition and per set size
summary_data <- get_summary_statistics(data = bays2009_full,
                                      unit = "radians",
                                      condition_var = "duration",
                                      set_size_var = "set_size")


mixtur documentation built on April 6, 2023, 5:19 p.m.