daytime_methods: Methods for class 'daytime'

In paulhibbing/daytime: Operate on time variables for physical behavior research

Methods for class daytime

Description

Methods for class daytime

Usage

## S3 method for class 'daytime'
mean(x, ...)

## S3 method for class 'daytime'
sd(x, units = c("min", "hr"), type = c("MSD", "SRL", "circular"), ...)

sd(x, ...)

Arguments

x	input data
...	arguments passed to methods
units	character scalar specifying the desired units of output for sd.daytime. Can be either "min" (for minutes) or "hr" (for hours)
type	character scalar specifying the method to use for sd. Choose from the mean shorter distance (the default; type = "MSD"), scaled resultant length (type = "SRL"), or type = "circular" to call circular::sd.circular

Examples

Time <- as_daytime(
  Sys.time()+rnorm(100, 0, 4*60*60), TRUE
)

## Wrap in `as.numeric` for better printing
as.numeric(mean(Time))
as.numeric(sd(Time))

## Compare
mean(as.numeric(Time))
sd(as.numeric(Time))
if (!!requireNamespace("PAutilities", quietly = TRUE)) PAutilities::mean_sd(Time)

paulhibbing/daytime documentation built on July 13, 2022, 6:32 p.m.