Learn R Programming

GGIR (version 2.6-0)

g.report.part5: Generate report from milestone data produced by g.part5

Description

Creates report from milestone data produced by g.part5. Not intended for direct use by package user

Usage

g.report.part5(metadatadir=c(),f0=c(),f1=c(),loglocation=c(),
                          includenightcrit=c(),includedaycrit=c(),
                          data_cleaning_file=c(),
                          includedaycrit.part5=2/3,
                          minimum_MM_length.part5=23,
                          week_weekend_aggregate.part5=FALSE,
                          LUX_day_segments=c())

Arguments

metadatadir
f0
f1
loglocation
includenightcrit

Despricated as of version 2.0, not used anymore in part 5 report

includedaycrit

Despricated as of version 2.0, not used anymore in part 5 report

data_cleaning_file
includedaycrit.part5

Inclusion criteria for number of valid hours, either as expressed as a ratio of 1 or as the number of hours in a 24 hour day.

minimum_MM_length.part5

Minimum length in hours of a MM day to be included in the cleaned part 5 results.

week_weekend_aggregate.part5

Boolean to indicate whether week and weekend-days aggregates should be stored. This is turned off by default as it generates a large number of extra columns in the output report.

LUX_day_segments

Value

Function does not produce data, but only writes reports in csv format

The following files are stored in the root of the results folder: part5_daysummary_* part5_personsummary_*

The following files are stored in the folder results/QC: part5_daysummary_full_*

See package vignette paragraph "Waking-waking or 24 hour time-use analysis" and "Output part 5" for a more elaborative description of the full day time-use and analysis and reporting.