actman: ACTman - Actigraphy Manager

In compsy/ACTman: Actigraphy manager

ACTman - Actigraphy Manager

Description

ACTman manages actigraphy data whilst offering pre-processing and analyses options. This initial version supports the 'Actiwatch 2' and 'MotionWatch 8' actigraphy devices, whilst allowing for both sleep and circadian rhythm analyses.

Usage

  ACTman(workdir = "C:/Bibliotheek/Studie/PhD/Publishing/ACTman/R-part/mydata2",
  sleepdatadir = paste("C:/Bibliotheek/Studie/PhD/Publishing/",
  "ACTman/R-part/Actogram & Sleep analysis", sep = ""),
  myACTdevice = "Actiwatch2", iwantsleepanalysis = FALSE,
  plotactogram = FALSE, selectperiod = FALSE, startperiod = NULL,
  daysperiod = FALSE, endperiod = NULL, movingwindow = FALSE,
  movingwindow.size = 14, movingwindow.jump = 1,
  circadian_analysis = TRUE, nparACT_compare = FALSE, na_omit = FALSE,
  na_impute = FALSE, missings_report = TRUE, lengthcheck = TRUE)

Arguments

workdir	The working directory of the script.
sleepdatadir	An optional vector specifying the directory for actogram and sleep analysis data.
myACTdevice	Name of the input device used. Should be either 'Actiwatch2' or 'MW8'.
iwantsleepanalysis	Boolean value indicating whether sleep analysis should be performed.
plotactogram	Value indicating if and what kind of actogram has to be plotted. Can be either '48h', '24h', or FALSE.
selectperiod	Boolean value indicating whether a specific period has to be selected.
startperiod	An optional vector specifying single or multiple period starts. Should be in the format "2016-10-03 00:00:00".
daysperiod	An optional vector specifying the length in days of the period.
endperiod	An optional argument that is a date string (format: "2016-10-03 00:00:00"), denoting the end of the data subset to be analyzed. Only used if daysperiod is not specified.
movingwindow	Boolean value indicating whether a moving window should be utilised.
movingwindow.size	An optional vector specifying the length in days of the moving window. Default is 14 days.
movingwindow.jump	An optional vector specifying the length of the jumps with which the moving window is shifted each iteration. Default is 1 day.
circadian_analysis	Boolean value indicating whether non-parametric circadian rhythm analysis should be performed.
nparACT_compare	Boolean value indicating that comparison with another actigraphy R package should be performed. If TRUE, the values for IS, IV, RA, L5, L5_starttime, M10, and M10_starttime of the nparACT_base_loop function are recorded in the returned overview variable.
na_omit	Boolean value indicating whether NA's should be omitted.
na_impute	Boolean value indicating whether NA's should be imputed.
missings_report	Boolean value indicating whether missings promt should appear.
lengthcheck	Boolean value. If TRUE, the dataset is shortened to the start date plus 14 days, and observations more than 14 days after the start date are removed.

Value

if iwantsleepanalysis, this returns the sleepdata overview, else if movingwindow, it returns the moving window results, and otherwise it returns the actdata overview.

Examples

## Not run: 
View(ACTman::ACTman(workdir = "C:/Bibliotheek/Studie/PhD/Publishing/ACTman/R-part/mydata2",
                    myACTdevice = "Actiwatch2",
                    iwantsleepanalysis = FALSE,
                    plotactogram = FALSE,
                    selectperiod = FALSE,
                    startperiod = "2016-10-03 00:00:00",
                    daysperiod = 14, movingwindow = FALSE, circadian_analysis = TRUE))

## End(Not run)

compsy/ACTman documentation built on Oct. 1, 2023, 8:40 a.m.