Fix generate seasonal documentation

R/generate_seasonal_data.R

@@ -8,6 +8,7 @@
 #' @param years An integer specifying the number of years of data to simulate.
 #' @param start_date A date representing the start date of the simulated data.
 #' @param amplitude A number specifying the amplitude of the seasonal wave.
+#' The output will fluctuate within the range `[mean - amplitude, mean + amplitude]`.
 #' @param mean A number specifying the mean of the seasonal wave. Must be greater than or equal to the amplitude.
 #' @param phase A numeric value (in radians) representing the horizontal shift
 #' of the sine wave, hence the phase shift of the seasonal wave. The phase must be between zero and 2*pi.

vignettes/generate_seasonal_wave.Rmd

@@ -34,7 +34,7 @@ $$
 Where:
 
 - $t$: The time variable (e.g., weeks or months, represented on the x-axis).
-- $\text{amplitude}$: Controls the height of the wave; the output oscillates between $\text{0 to 2 * amplitude}$.
+- $\text{amplitude}$: Controls the height of the oscillations; the output varies between **\( \text{mean} \pm \text{amplitude} \)**.
 - $\text{mean}$: The baseline value around which the seasonal wave oscillates. Must be greater than or equal to the amplitude.
 - $\text{period}$: Defines the cycle length (e.g., 52 weeks for yearly seasonality) (is calculated based on `time_interval`).
 - $\text{phase}$: Adjusts the horizontal position of the wave on the x-axis.