export_all: Export plots and data outputed by the package

View source: R/export_all.R

export_allR Documentation

Export plots and data outputed by the package

Description

Creates a folder in which all the data and plots resulting from the analysis will be saved.

Usage

export_all(processed_data = NULL, rythm_analysis_data = NULL, autocorrelation = TRUE, lomb_scargle = TRUE,
cosinor_fit = c("lomb_scargle", "autocorrelation"), dir_choose_gui = TRUE, new_dir_name = "analysis")

Arguments

raw_data

data.frame or tibble containing the raw data.

processed_data

data.frame returned from the process_timeseries or multivariate_process_timeseries functions.

rythm_analysis_data

data.frame returned from the rythm_analysis_by_window and multivariate_rythm_analysis functions.

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)

autocorrelation

If TRUE (default) plots autocorrelation. FALSE does not plot autocorrelation.

lomb_scargle

If TRUE (default) plots lomb scargle periodogram. FALSE does not plot periodogram.

cosinor_fit

Method to fit the COSINOR to the data. Either "lomb_scargle" (default) or "autocorrelation".

dir_choose_gui

If TRUE (default) a GUI will help select the folder in which to save the data and plots. If FALSE, everything will be saved in the current directory.

new_dir_name

Optional character argument to name the folder in which the data will be saved.

Examples

export_all(processed_data = processed_data, rythm_analysis_data = analysis_data, new_dir_name = "test")


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