diff --git a/dev/reference/gg_lag.html b/dev/reference/gg_lag.html index 6cd1b50a..d091af6c 100644 --- a/dev/reference/gg_lag.html +++ b/dev/reference/gg_lag.html @@ -97,7 +97,14 @@

Arguments

period
-

The seasonal period to display.

+

The seasonal period to display. If NULL (default), +the largest frequency in the data is used. If numeric, it represents +the frequency times the interval between observations. If a string +(e.g., "1y" for 1 year, "3m" for 3 months, "1d" for 1 day, +"1h" for 1 hour, "1min" for 1 minute, "1s" for 1 second), +it's converted to a Period class object from the lubridate package. +Note that the data must have at least one observation per seasonal period, +and the period cannot be smaller than the observation interval.

lags
diff --git a/dev/reference/gg_season.html b/dev/reference/gg_season.html index f7c11371..1c2b2493 100644 --- a/dev/reference/gg_season.html +++ b/dev/reference/gg_season.html @@ -107,7 +107,14 @@

Arguments

period
-

The seasonal period to display.

+

The seasonal period to display. If NULL (default), +the largest frequency in the data is used. If numeric, it represents +the frequency times the interval between observations. If a string +(e.g., "1y" for 1 year, "3m" for 3 months, "1d" for 1 day, +"1h" for 1 hour, "1min" for 1 minute, "1s" for 1 second), +it's converted to a Period class object from the lubridate package. +Note that the data must have at least one observation per seasonal period, +and the period cannot be smaller than the observation interval.

facet_period
diff --git a/dev/reference/gg_subseries.html b/dev/reference/gg_subseries.html index be936b39..8a4d1964 100644 --- a/dev/reference/gg_subseries.html +++ b/dev/reference/gg_subseries.html @@ -97,7 +97,14 @@

Arguments

period
-

The seasonal period to display.

+

The seasonal period to display. If NULL (default), +the largest frequency in the data is used. If numeric, it represents +the frequency times the interval between observations. If a string +(e.g., "1y" for 1 year, "3m" for 3 months, "1d" for 1 day, +"1h" for 1 hour, "1min" for 1 minute, "1s" for 1 second), +it's converted to a Period class object from the lubridate package. +Note that the data must have at least one observation per seasonal period, +and the period cannot be smaller than the observation interval.

...