convert_to_ts: Convert Data to Time Series Format

In TidyDensity: Functions for Tidy Analysis and Generation of Random Data

Convert Data to Time Series Format

Description

This function converts data in a data frame or tibble into a time series format. It is designed to work with data generated from tidy_ distribution functions. The function can return time series data, pivot it into long format, or both.

Usage

convert_to_ts(.data, .return_ts = TRUE, .pivot_longer = FALSE)

Arguments

.data	A data frame or tibble to be converted into a time series format.
.return_ts	A logical value indicating whether to return the time series data. Default is TRUE.
.pivot_longer	A logical value indicating whether to pivot the data into long format. Default is FALSE.

Details

The function takes a data frame or tibble as input and processes it based on the specified options. It performs the following actions:

1. Checks if the input is a data frame or tibble; otherwise, it raises an error.

2. Checks if the data comes from a tidy_ distribution function; otherwise, it raises an error.

3. Converts the data into a time series format, grouping it by "sim_number" and transforming the "y" column into a time series.

4. Returns the result based on the chosen options:

   • If ret_ts is set to TRUE, it returns the time series data.

   • If pivot_longer is set to TRUE, it pivots the data into long format.

   • If both options are set to FALSE, it returns the data as a tibble.

Value

The function returns the processed data based on the chosen options:

• If ret_ts is set to TRUE, it returns time series data.

• If pivot_longer is set to TRUE, it returns the data in long format.

• If both options are set to FALSE, it returns the data as a tibble.

Author(s)

Steven P. Sanderson II, MPH

Examples

# Example 1: Convert data to time series format without returning time series data
x <- tidy_normal()
result <- convert_to_ts(x, FALSE)
head(result)

# Example 2: Convert data to time series format and pivot it into long format
x <- tidy_normal()
result <- convert_to_ts(x, FALSE, TRUE)
head(result)

# Example 3: Convert data to time series format and return the time series data
x <- tidy_normal()
result <- convert_to_ts(x)
head(result)

TidyDensity documentation built on Nov. 2, 2023, 5:38 p.m.