plot_actogram: Export/Plot Actogram

In edpclau/circadian-dynamics: Period and Rythm Analysis of Timeseries Data

Export/Plot Actogram

Description

Export/Plot Actogram

Usage

plot_actogram(df = NULL, ld_data = NULL, datetime_column = 1, filename = "actogram.pdf",
export = FALSE, width = 12, height = 12, dpi = 800, nrow = 5, ncol = 5)

Arguments

df	A data.frame or tibble which contains a datetime column and measurement values.
ld_data	A data.frame/Tibble with 2 columns. Column 1 is a datetime object and column 2 is the light/dark indicator. (defult = NULL)
datetime_column	An integer which indicates the column that contains the datetime. Default = 1.
filename	A charater string ending with ".pdf" which customizes the name of the file to be exported. "actogram.pdf" (default)
export	Logical. If FALSE (default), it will open a window with the plots. If TRUE, saves the plots on the current directory in pdf format.
width	a numeric indicating the width of the page of the pdf file. default = 12
height	a numeric indicating height of the page of the pdf file. default = 12
nrow	a numeric indicating how many rows of plots to put in a page. default = 5
ncol	a numeric indicating how many columns of plots to put in a page. default = 5
autosize	Logical. If TRUE, will make the figures bigger as the number of days increase. If FALSE (default) will plot 25 figures per page.

Details

Exports actogram plots for each column of a data.frame of tibble with a datetime object.

Examples

plot_actogram(df = monitor,
datetime_column = 1, filename = "actogram.pdf",
export = FALSE)

edpclau/circadian-dynamics documentation built on Aug. 25, 2023, 12:18 p.m.