g.part5: Merge output from physical activity and sleep analysis into...

View source: R/g.part5.R

g.part5R Documentation

Merge output from physical activity and sleep analysis into one report

Description

Function to merge the output from g.part2 and g.part4 into one report enhanced with profiling of sleep and physical activity stratified across intensity levels and based on bouted periods as well as non-bouted periods.

Usage

g.part5(datadir = c(), metadatadir = c(), f0 = c(), f1 = c(),
                   params_sleep = c(), params_metrics = c(),
                   params_247 = c(), params_phyact = c(), 
                   params_cleaning = c(), params_output = c(),
                   params_general = c(), verbose = TRUE, ...)

Arguments

datadir

Directory where the accelerometer files are stored, e.g. "C:/mydata", or list of accelerometer filenames and directories, e.g. c("C:/mydata/myfile1.bin", "C:/mydata/myfile2.bin").

metadatadir

Directory that holds a folder 'meta' and inside this a folder 'basic' which contains the milestone data produced by g.part1. The folderstructure is normally created by g.part1 and GGIR will recognise what the value of metadatadir is.

f0

File index to start with (default = 1). Index refers to the filenames sorted in alphabetical order

f1

File index to finish with (defaults to number of files available, i.e., f1 = 0)

params_sleep

See details in GGIR.

params_metrics

See details in GGIR.

params_247

See details in GGIR.

params_phyact

See details in GGIR.

params_cleaning

See details in GGIR.

params_output

See details in GGIR.

params_general

See details in GGIR.

verbose

See details in GGIR.

...

To ensure compatibility with R scripts written for older GGIR versions, the user can also provide parameters listed in the params_ objects as direct argument.

Value

The function does not produce values but generates an RData file in the milestone subfolder ms5.out which incudes a dataframe named output. This dataframe is used in g.report.part5 to create two reports one per day and one per person. See package vignette paragraph "Output part 5" for description of all the variables.

Author(s)

Vincent T van Hees <v.vanhees@accelting.com>

Examples

  ## Not run: 
    metadatadir = "C:/myfolder/meta"
    g.part5(metadatadir=metadatadir)
  
## End(Not run)

GGIR documentation built on Oct. 17, 2023, 1:12 a.m.