zeitgeber: Create Table of Time Cues

In fascinatingfingers/zeitgebeR: Machine Learning Enhancements for the Philips Hue Lighting System

Description

Zeitgeber, Geman for time-giver, are external cues that help synchronize an organism's biolgical rhythms to Earth's day/night cycles and seasons. This eponymous function takes a vector of date/time values (plus latitude/longitude values retrieved from the session options; see Details) and returns a dplyr::data_frame() of zeitgeber features.

Usage

zeitgeber(time = Sys.time(), lat = getOption("DarkSky")$lat,
  lon = getOption("DarkSky")$lon)

Arguments

time	vector of date/time values
lat	latitude (in decimal degrees). Positive north; negative south.
lon	longitude (in decimal degrees). Positive east; negative west.

Details

This function retrieves location information saved in options()$DarkSky. Before calling this function, set your credentials and other configuration details with a call to set_configuration.

Value

Returns a data_frame with the following diurnal features:

• datetime

• solar_elevation (in degrees)

• solar_azimuth (in degrees)

• solar_azimuth_x east–west movement, scaled [-1, 1]

• solar_azimuth_y north–south movement, scaled [-1, 1]

• civil_daylight TRUE when the solar elevation is greater than -6°

• nautical_daylight TRUE when the solar elevation is greater than -12°

• astronomical_daylight TRUE when the solar elevation is greater than -18°

• working_hours TRUE from 9a–5p; 10a–6p on weekends

• awake_hours TRUE from 8a–12a; 9a–1a on weekends

fascinatingfingers/zeitgebeR documentation built on Oct. 25, 2019, 4:50 p.m.