std_cum_prod_augment: Augment Cumulative Product

In RandomWalker: Generate Random Walks Compatible with the 'tidyverse'

Augment Cumulative Product

Description

This function augments a data frame by adding cumulative product columns for specified variables.

Usage

std_cum_prod_augment(.data, .value, .names = "auto", .initial_value = 1)

Arguments

.data	A data frame to augment.
.value	A column name or names for which to compute the cumulative product.
.names	Optional. A character vector of names for the new cumulative product columns. Defaults to "auto", which generates names based on the original column names.
.initial_value	A numeric value to start the cumulative product from. Defaults to 1.

Details

The function takes a data frame and a column name (or names) and computes the cumulative product for each specified column, starting from an initial value. If the column names are not provided, it will throw an error.

Value

A tibble with the original data and additional columns containing the cumulative products.

Author(s)

Steven P. Sanderson II, MPH

See Also

Other Utility Functions: convert_snake_to_title_case(), generate_caption(), get_attributes(), rand_walk_helper(), running_quantile(), std_cum_max_augment(), std_cum_mean_augment(), std_cum_min_augment(), std_cum_sum_augment()

Examples

df <- data.frame(x = 1:5, y = 6:10)
std_cum_prod_augment(df, .value = x)
std_cum_prod_augment(df, .value = y, .names = c("cumprod_y"))

RandomWalker documentation built on Oct. 23, 2024, 5:07 p.m.