kronos {kronos}

Fit a cosinor model and extract relevant parameters

Description

This is the main workhorse function in the 'kronos' package. It manages the individual functionalities of 'kronos', including rhythmicity analysis and differential rhythmicity.

Usage

kronos(
  formula,
  data,
  time = NULL,
  period = 24,
  verbose = TRUE,
  pairwise = TRUE
)

Arguments

formula

A formula. Use the time function to designate which variable represents time.

data

input data

time

A string. Should be the column name containing the time values.

period

A numeric. The length of a period, in the same format as the time variable

verbose

A boolean. Toggles whether to print diagnostic information while running. Useful for debugging errors on large data sets.

pairwise

A boolean. Toggles whether to perform pairwise ANOVAs as a TukeyHSD-like post-hoc.

Value

A kronosOut S4 object containing coefficients and all operations.

Examples

#Load prepared data stored in Kronos library
data("kronos_demo")
output <- kronos(formula = Variable_1 ~ time(Timepoint), 
data = onevariable, period = 24, verbose = TRUE, pairwise = FALSE)

#Extracting data from the output object:
getKronos_fit(output)
getKronos_trace(output)
getKronos_groupwise(output)

#Plotting:
gg_kronos_circle(output)
gg_kronos_sinusoid(output)

#For high-dimensional data, use fw_kronos:
out_list = fw_kronos(x = bigdata[1:50,], formula = ~ Group + time(Timepoint), 
metadata = bigmeta, period = 24, verbose = FALSE, pairwise = TRUE) 

#Extracting data from the output object: 
kronosListToTable(out_list)


#Plotting:
gg_kronos_acrogram(out_list)