get_participant_id: Query and set elements of the 'epochs' metadata structures

View source: R/epoch_queries.R

get_participant_idR Documentation

Query and set elements of the epochs metadata structures

Description

These functions are used to query and set the participant_id and recording fields of an epochs structure within any eegUtils object. Note that the two set_* functions do not operate on eeg_group objects.

Usage

get_participant_id(data)

get_recording(data)

set_participant_id(data, participant_id)

set_recording(data, recording)

Arguments

data

An eegUtils object.

participant_id

A character vector giving the name to use for the participant_id for a particular object.

recording

A character vector giving the name to use for the EEG recording.

Value

  • get_participant_id() returns a character vector containing the participant_id

  • get_recording() returns a character vector containing the recording from values of recording from the eegUtils object

  • set_participant_id() returns the full eegUtils object with the participant_id field modified in the epochs structure

  • set_recording() returns the full eegUtilsobject with the recording field modified in the epochs structure

Author(s)

Matt Craddock matt@mattcraddock.com

Examples

get_participant_id(demo_epochs)
get_recording(demo_epochs)
set_participant_id(demo_epochs, "002")
set_recording(demo_epochs, "test_recording")

neuroconductor/eegUtils documentation built on Feb. 3, 2023, 5:33 p.m.