get_step_average: Compute average daily steps taken.

View source: R/daily_behaviour.R

get_step_averageR Documentation

Compute average daily steps taken.

Description

This function computes the daily arithmetic mean of a week of steps taken as measured by a pedometer (step_average). This variable is used to compute the step score (step_score).

Usage

get_step_average(raw_data = NULL)

Arguments

raw_data

A data frame that includes seven days of pedometer steps and their corresponding on and off times. See Details for how these variables must be named.

Details

This function will throw an error unless the following variables are found in the raw_data argument:

  • steps1

  • steps2

  • steps3

  • steps4

  • steps5

  • steps6

  • steps7

  • time_on1

  • time_on2

  • time_on3

  • time_on4

  • time_on5

  • time_on6

  • time_on7

  • time_off1

  • time_off2

  • time_off3

  • time_off4

  • time_off5

  • time_off6

  • time_off7

There must be at least three valid days for an arithmetic mean to be computed. If only three valid days, one of the step values from a valid day will be randomly sampled and used for the fourth valid day before computing the mean.

Other capl functions called by this function include: validate_steps() and get_pedometer_wear_time().

Value

Returns a data frame with nine columns: steps1 (validated), steps2 (validated), steps3 (validated), steps4 (validated), steps5 (validated), steps6 (validated), steps7 (validated), valid_days and step_average. The steps are validated with the validate_steps() function.

Examples

capl_demo_data <- get_capl_demo_data(10)

get_step_average(capl_demo_data)$step_average

# [1] 18365 12655 15493 12966 11396 13954 18456 13589 17543 11276


capl documentation built on April 8, 2022, 9:06 a.m.