Skip to content

Commit

Permalink
minor improvement to documentation of behaviouralcodes.csv
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentvanhees committed Feb 19, 2024
1 parent 7ae94f7 commit 2af302f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion vignettes/GGIR.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -1660,7 +1660,7 @@ correspond to the date of analysis.
| invalidepoch | Is 1 if epoch was detect as invalid (e.g. non-wear), 0 if not. |
| guider | Number to indicate what guider type was used, where 1=sleeplog, 2=HDCZA, 3=swetwindow, 4=L512, 5=HorAngle, 6=NotWorn |
| window | Numeric indicator of the analysis window in the recording. If timewindow = "MM" then these correspond to calendar days, if timewindow = "WW" then these correspond to which wakingup-wakingup window in the recording, if timewindow = "OO" then these correspond to which sleeponset-sleeponset window in the recording. So, in a recording of one week you may find window numbers 1, 2, 3, 4, 5 and 6.|
| class_id | The behavioural class codes are documented in the exported csv file meta/ms5outraw/behaviouralcodes.csv. Class codes above class 8 will be analysis specific, because it depends on the number time variants of the bouts used. For example, if you look at MVPA lasting 1-10, 10-20, 30-40 then all of them will have their own class_id. |
| class_id | The behavioural class codes are documented in the exported csv file meta/ms5outraw/behaviouralcodes.csv. Class codes above class 8 will be analysis specific, because it depends on the number time variants of the bouts used. For example, if you look at MVPA lasting 1-10, 10-20, 30-40 then all of them will have their own class_id. In behaviouralcodes.csv you will find a column with class_names which match the behavioural classes as reported in the part 5 report. |
| invalid_fullwindow | Fraction of the window (see above) that represents invalid data. I added this to make it easier to filter the timeseries based on whether days are valid or not. |
| invalid_sleepperiod | Fraction of SPT within the current window that represents invalid data. |
| invalid_wakinghours | Fraction of SPT within the current window that represents invalid data. |
Expand Down

0 comments on commit 2af302f

Please sign in to comment.