diff --git a/eeg_eyetracking_parser/braindecode_utils.py b/eeg_eyetracking_parser/braindecode_utils.py index e98ad4f..5af81a8 100644 --- a/eeg_eyetracking_parser/braindecode_utils.py +++ b/eeg_eyetracking_parser/braindecode_utils.py @@ -79,7 +79,6 @@ def decode_subject(subject_nr, factors, epochs_kwargs, trigger, tuple A (results, metadata) tuple. - Results is a dict where keys are labels with 'overall' corresponding to the overall (unlesioned) test, and the other keys corresponding to the lesions as provided by the lesions parameter. Values are confusion diff --git a/readme-template.md b/readme-template.md index 6df893d..e130822 100644 --- a/readme-template.md +++ b/readme-template.md @@ -78,7 +78,7 @@ from datamatrix import convert as cnv import time_series_test as tst dm = cnv.from_pandas(metadata) -dm.pupil = eet.epochs_to_series(dm, cue_epoch) +dm.pupil = eet.epochs_to_series(dm, cue_epoch, baseline_trim=(-2, 2)) tst.plot(dm, dv='pupil', hue_factor='cue_eccentricity') ``` diff --git a/readme.md b/readme.md index 1ecfc7b..4475eae 100644 --- a/readme.md +++ b/readme.md @@ -78,7 +78,7 @@ from datamatrix import convert as cnv import time_series_test as tst dm = cnv.from_pandas(metadata) -dm.pupil = eet.epochs_to_series(dm, cue_epoch) +dm.pupil = eet.epochs_to_series(dm, cue_epoch, baseline_trim=(-2, 2)) tst.plot(dm, dv='pupil', hue_factor='cue_eccentricity') ``` @@ -194,13 +194,13 @@ right away for subsequent calls. For more information, see -## epochs\_to\_series_(dm, epochs, baseline\_trim=(-2, 2))_ +## epochs\_to\_series_(dm, epochs, baseline\_trim=None)_ -Takes an Epochs or PupilEpochs object and converts it to a DataMatrix -SeriesColumn. If a baseline has been specified in the epoch, it is applied -to each row of the series separately. Rows where the mean baseline value -(z-scored) is not within the range indicated by `baseline_trim` are set to -`NAN`. +Takes an Epochs, PupilEpochs, or EpochsTFR object and converts it to a +DataMatrix SeriesColumn. If a baseline has been specified in the epoch, it +is applied to each row of the series separately. Rows where the mean +baseline value (z-scored) is not within the range indicated by +`baseline_trim` are set to `NAN`. ### Parameters @@ -208,7 +208,7 @@ to each row of the series separately. Rows where the mean baseline value A DataMatrix object to which the series belongs -* **epochs: Epochs or PupilEpochs** +* **epochs: Epochs, PupilEpochs, or EpochsTFR** The source object with the epoch data. @@ -415,3 +415,4 @@ values between 128 and 255 (inclusive). `eeg_eyetracking_parser` is licensed under the [GNU General Public License v3](http://www.gnu.org/licenses/gpl-3.0.en.html). +