typical_day: Calculate average parameters for each timepoint in a...

Description Usage Arguments Value Functions Examples

View source: R/typical_day.R

Description

This function calculates the typical parameters in a dataframe for one circadian cycle. Use this function on a dataframe generated from a DSI export using the DSI_export_to_dataframe function.

Usage

1
2
3
typical_day(data, lights_on, include_lights = FALSE)

typical_average(data, avg_minutes)

Arguments

data

A dataframe created using the DSI_export_to_dataframe function.

lights_on

Time when the lights turn on. (24H)

include_lights

A boolean for including columns showing status of room lights. FALSE by default. If TRUE, output includes a column for light status ("LightsOn") and a column for time since lights turned on ("LightsTime")

avg_minutes

Number of minutes to average over (integer)

Value

A dataframe containing a column of circadian time and parameters.

Functions

Examples

1
2
typical_day(data = sample_BP_data, lights_on = 21)
typical_day(data = sample_BP_data, lights_on = 6)

andrewstiegler/telemetRy documentation built on May 1, 2021, 4:56 p.m.