GGIR3.1-4 package

Raw Accelerometer Data Analysis

appendRecords

Append GGIR milestone data from neighbouring or overlapping recordings

applyCosinorAnalyses

Apply Cosinor Analyses to time series

applyExtFunction

Apply external function to acceleration data.

CalcSleepRegularityIndex

Calculates Sleep Regularity Index

check_log

Function to revise format of user-provided logs

check_myfun

Checks myfun object before it is passed to applyExtfunction

check_params

Check default parameters

checkMilestoneFolders

Checks for existence of folders to process

convertEpochData

convert external Epoch data to GGIR part 1 milestone data format

correctOlderMilestoneData

Corrects milestone data from g.part1 generated in older GGIR versions

cosinorAnalyses

Apply cosinor anlaysis and extended cosinor analysis

create_test_acc_csv

Creates csv data file for testing purposes

create_test_sleeplog_csv

Creates csv sleeplog file for testing purposes

createConfigFile

Creates Config File based on variables in function GGIR environment

datadir2fnames

Generates vector of file names out of datadir input argument

detect_nonwear_clipping

Detect non-wear and clipping time in the raw accelerometer data

extract_params

Extract parameters from input and add them to params

extractID

Extract ID from file header object

g.abr.day.names

Abbreviates daynames to numbers, needed for report generation in g.plo...

g.analyse.avday

Function supports g.analyse . Not intended for direct use by user.

g.analyse.perday

Function supports g.analyse . Not intended for direct use by user.

g.analyse.perfile

Function supports g.analyse . Not intended for direct use by user.

g.analyse

Function to analsyse meta-data generated by g.getmeta and g.impute

g.applymetrics

Extract metrics from acceleration signals

g.calibrate

function to estimate calibration error and make recommendation for add...

g.conv.actlog

Function to read activity log and make it useful for the rest of GGIR.

g.convert.part2.long

Convert part 2 report to long format

g.create.sp.mat

Converts sleep period information. Not intended for direct use

g.detecmidnight

Detect all midnights in a time series

g.dotorcomma

Assesses whether decimals in fileheader are stored with comma or dot s...

g.extractheadervars

Extracts header variables from header object

g.fragmentation

Fragmentation metrics from time series.

g.getbout

function to calculate bouts from vector of binary classes

g.getM5L5

Extract M5 and L5 from time series

g.getmeta

Function to extract meta-data (features) from data in accelerometer fi...

g.getstarttime

Extract start time of a measurement

g.impute

Function to identify invalid periods in the meta-data as generated by ...

g.imputeTimegaps

Impute gaps in three axis raw accelerometer data

g.inspectfile

function to inspect accelerometer file for brand, sample frequency and...

g.intensitygradient

Intensity gradient calculation

g.IVIS

Calculates IV and IS

g.loadlog

Load and clean sleeplog information

g.part1

function to load and pre-process acceleration files

g.part2

function to analyse and summarize pre-processed output from g.part1

g.part3

Detection of sustained inactivity periods as needed for sleep detectio...

g.part4_extradctid

Extracts ID from filename and finds matching rows in sleeplog

g.part4

Labels detected sustained inactivity periods by g.part3 as either part...

g.part5_analyseSegment

Analyses the time series per time segment for part 5

g.part5_initialise_ts

Initialise time series data from for part 5

g.part5.addfirstwake

Adds first wake if it is missing in part 4 output.

g.part5.addsib

Adds the sustained inactivity bout to the ts series.

g.part5.analyseRest

Analyse rest (internal function)

g.part5.classifyNaps

Classify Naps from identified sustained inactivty bouts

g.part5.definedays

Fix missing night in part 4 output

g.part5.fixmissingnight

Fix missing night in part 4 output

g.part5.handle_lux_extremes

Check lux values for extremes and imputes or removes them

g.part5.lux_persegment

Extract key lux variables per segment of the data.

g.part5.ontsetwaketiming

Identify wake and sleepperiod window timing

g.part5

Merge output from physical activity and sleep analysis into one report

g.part5.savetimeseries

Saves part 5 time series to csv files

g.part5.wakesleepwindows

Label wake and sleepperiod window

g.part6

Perform temporal pattern analyses

g.plot

function to generate a plot for quality check purposes

g.plot5

Generate user-friendly visual report. The first part of the report sum...

g.readaccfile

Generic functiont to read large blocks of accelerometer data

g.readtemp_movisens

Reads the temperature from movisens files.

g.report.part2

Generate report from milestone data produced by g.part2

g.report.part4

Generate report from milestone data produced by g.part4

g.report.part5_dictionary

Generate data dictionary for reports from milestone data produced by g...

g.report.part5

Generate report from milestone data produced by g.part5

g.report.part6

Generate report from milestone data produced by g.part6

g.shell.GGIR

Wrapper function around function GGIR

g.sib.det

sustiained inactivty bouts detection

g.sib.plot

Create plot of sustained inactivity bouts

g.sib.sum

sustiained inactivty bouts detection

g.sibreport

Generate sustiained inactivty bouts report

g.weardec

Detects whether accelerometer is worn

get_nw_clip_block_params

Set monitor brand specific parameters

get_starttime_weekday_truncdata

Get starttime (adjusted), weekday, and adjust data accordingly.

getfolderstructure

Extracts folderstructure based on data directory.

GGIR-package

A package to process multi-day raw accelerometer data

GGIR

Shell function for analysing an accelerometer dataset.

HASIB

Heuristic algorithms for sustiained inactivty bouts detection

HASPT

Heuristic Algorithms estimating SPT window.

identify_levels

Identifies levels of behaviour for g.part5 function.

is_this_a_dst_night

Check whether the night starting on a calendar date has DST.

is.ISO8601

Check whether character timestamp is in iso8601 format.

isfilelist

Checks whether datadir is a directory or a vector with filenames

ismovisens

Checks whether the files to process are collected with movisens accele...

iso8601chartime2POSIX

Convert iso8601 timestamps to POSIX timestamp

load_params

Load default parameters

parametersVignette

Builds Section for Parameters Vignette

part6AlignIndividuals

part6AlignIndividuals

part6PairwiseAggregation

part6PairwiseAggregation

POSIXtime2iso8601

Convert POSIX to iso8601 timestamp

read.myacc.csv

Read custom csv files with accelerometer data

ShellDoc2Vignette

Extract Definition from Shell Documentation

tidyup_df

Round numeric columns and replace NA/NaN values by blank

updateBlocksize

Update blocksize of data to be read depending on available memory.

A tool to process and analyse data collected with wearable raw acceleration sensors as described in Migueles and colleagues (JMPB 2019), and van Hees and colleagues (JApplPhysiol 2014; PLoSONE 2015). The package has been developed and tested for binary data from 'GENEActiv' <https://activinsights.com/>, binary (.gt3x) and .csv-export data from 'Actigraph' <https://theactigraph.com> devices, and binary (.cwa) and .csv-export data from 'Axivity' <https://axivity.com>. These devices are currently widely used in research on human daily physical activity. Further, the package can handle accelerometer data file from any other sensor brand providing that the data is stored in csv format. Also the package allows for external function embedding.

  • Maintainer: Vincent T van Hees
  • License: Apache License (== 2.0) | file LICENSE
  • Last published: 2024-09-03