create_participantgroup_widedata: Create a ParticipantGroup instance

In synr: Explore and Process Synesthesia Consistency Test Data

Create a ParticipantGroup instance

Description

Takes in a data frame of raw consistency test data and returns a ParticipantGroup instance, to which all the relevant data are linked. See the example data frame synr_exampledf_wide_small and its documentation (help(synr_exampledf_wide_small)) for information on the format that this function expects data to be in.

Participant id and (optional) test date column names are specified with the exact column names used in the data frame passed to the function. Symbol (i. e. grapheme), response color and response time (optional) columns are specified using regular expressions. You can read about regular expressions using R here if you want to, but basically what you want to do is this: say your columns with response colors are named "chosen_color_001", "chosen_color_002" and so on. You then simply set color_col_regex="chosen_color" when calling this function. The important thing is that you specify a part of the column names that is unique for the type of column you want to indicate. So if your symbol/grapheme columns are named "grapheme_1", "grapheme_2" ... and your participant id column is named "graphparticipant_1" ..., then symbol_col_regex="graph" wouldn't work, but symbol_col_regex="grapheme_" or even symbol_col_regex="graphe" would.

Usage

create_participantgroup_widedata(
  raw_df,
  n_trials_per_grapheme = 3,
  participant_col_name,
  symbol_col_regex,
  color_col_regex = "colou*r",
  time_col_regex = NULL,
  testdate_col_name = NULL,
  color_space_spec = "Luv"
)

Arguments

raw_df	A data frame of raw consistency test data.
n_trials_per_grapheme	A one-element numeric vector holding the number of trials per grapheme that was used in the consistency test the data are from.
participant_col_name	A one-element character vector that holds the column name used for the column in raw_df that holds participant id's. (e. g. "participant_id" for the synr::synr_exampledf_wide_small)
symbol_col_regex	A one-element character vector with a regular expression (see above) unique to columns in the passed data frame that hold trial graphemes/symbols.
color_col_regex	A one-element character vector with a regular expression (see above) unique to columns in the passed data frame that hold response color hex codes.
time_col_regex	(optional) A one-element character vector with a regular expression (see above) unique to columns in the passed data frame that hold response times (times from stimulus presentation to response).
testdate_col_name	(optional) A one-element character vector that holds the column name used for the column in raw_df that holds test dates (dates when participants finished the consistency test).
color_space_spec	A one-element character vector. What color space is to be used for analyses of the data? The following color spaces are supported: "XYZ", "sRGB", "Apple RGB", "Lab", and "Luv"

Examples

pg <- create_participantgroup_widedata(raw_df=synr_exampledf_wide_small,
                              n_trials_per_grapheme=2,
                              participant_col_name="participant_id",
                              symbol_col_regex="symbol",
                              color_col_regex="colou*r",
                              time_col_regex="response_time",
                              color_space_spec="Luv"
)
cons_means <- pg$get_mean_consistency_scores()
print(cons_means)

synr documentation built on June 22, 2024, 7:25 p.m.