bnicenboim / eeguana

A package for manipulating EEG data in R.
https://bnicenboim.github.io/eeguana/
Other
21 stars 9 forks source link

Added detail to read function docs #82

Closed stonekate closed 5 years ago

stonekate commented 5 years ago

In the descriptions, I describe the whole eeg_lst structure... the read functions seem like the right place for this, but see what you think.

Is this an accurate statement about the events table? I kind of made it up: "The .channel column is a linking variable only, so will generally only contain NAs, unless the event is specific to a certain channel."

bnicenboim commented 5 years ago

I think that whatever structure is common to all read should go to the function eeg_lst. What you wrote about .channel seems right, but I don't know why "linking"?

stonekate commented 5 years ago

Ah yes, that makes sense.

Re linking, I thought maybe that variable linked to the channels_tbl or something, but I'll delete that bit :)

stonekate commented 5 years ago

hmm. maybe it's a bit light on detail now... but I don't really know what else to say about e.g. reading an edf file!