plot_error: Plot response error of behavioural data relative to target...

In mixtur: Modelling Continuous Report Visual Short-Term Memory Studies

Plot response error of behavioural data relative to target values.

Description

Function to plot the response error in behavioural data relative to target values. Requires a data frame that (at least) has target value data and participant response data.

Usage

plot_error(
  data,
  unit = "degrees",
  id_var = "id",
  response_var = "response",
  target_var = "target",
  set_size_var = NULL,
  condition_var = NULL,
  n_bins = 18,
  n_col = 2,
  return_data = FALSE,
  palette = "Dark2",
  scale_y_axis = NULL
)

Arguments

data	A data frame with columns containing: participant identifier ('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 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 column name coding for the participants' responses.
target_var	The column name coding for the target value.
set_size_var	The column name (if applicable) coding for the set size of each response.
condition_var	The column name (if applicable) coding for the condition of each response.
n_bins	An integer controlling the number of cells / bins used in the plot.
n_col	An integer controlling the number of columns in the resulting plot.
return_data	A boolean (TRUE or FALSE) indicating whether the data for the plot should be returned.
palette	A character stating the preferred colour palette to use. To see all available palettes, type ?scale_colour_brewer into the console.
scale_y_axis	A vector of 2 elements stating the minimum and maximum value to use for the y-axis in the plots.

Value

If return_data is set to FALSE (which it is by default), the function returns a ggplot2 object visualising the density distribution of response error averaged across participants (if applicable) per set-size (if applicable) and condition (if applicable).

If return_data is set to TRUE, the function returns a list with two components:

• plot: The ggplot2 object.

• data: A data frame with the data used to generate the plot.

Examples

plot_error(bays2009_full,
          unit = "radians",
          set_size_var = "set_size")

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