Changelog

Source: NEWS.md

season 0.3.16.9000

• Added a NEWS.md file to track changes to the package.

New features

• New vignette, “Modelling monthly data”, which demonstrates how to use createAdj() with the nimble R package.
• autoplot() (the ggplot version of base R’s plot method) methods added for peri, third, Cosinor, monthglm, Monthmean, nsCosinor, and nonlintest classes. Each returns a ggplot object that can be extended with + theme_bw(), + labs(), etc. (#42, #33).
• New plot_circle() and plot_month() functions return ggplot objects (#42).
• added broom tidiers: tidy(), augment(), and glance() (#39)
• Made ciPhase() return data.frame rather than list() (#43)
• Made invyrfraction_chr() and invyrfraction_num() to avoid specifying text = TRUE/FALSE, and make function use more explicit, (#43)
• Made peri() return a list with columns peri, freq_radians (formerly f) and freq_cycles
• made sinusoid() return a tibble(), and made an autoplot method
• removed cat() print in wtest() and return a tibble not a list()
• For nscosinor, now optionally specify year and month column name, so you don’t need to have columns specifically named “year” or “month” - they could be “yr”, or “mn” even. #44
• For casecross, now optionally specify date column name, so you don’t need to have columns specifically named “date”. #44

Deprecations

• The plot argument of peri() and third() is soft-deprecated. These functions now always return a classed object ("peri", "third"); use autoplot() to draw the plot. Passing plot = FALSE is also deprecated — just drop the argument (#33).
• plot.Cosinor(), plot.monthglm(), plot.Monthmean(), plot.nsCosinor(), and plot.nonlintest() are soft-deprecated in favour of autoplot() methods. The base R / ggplot output of the deprecated plot() methods is unchanged — only the recommended path has moved.
• The plot argument of plot.nonlintest() is soft-deprecated.
• plotCircle() and plotMonth() are soft-deprecated in favour of new ggplot-returning plot_circle() and plot_month(). The deprecated functions continue to produce their existing output until removal.

All deprecated paths emit a one-time warning per session pointing at the replacement.

Breaking change

• monthmean() argument, adjmonth must be one of “none” (default), “thirty”, or “average”, rather than: FALSE, “thirty”, or “average”.
• createAdj() argument, filepath has been removed, as it is no longer required.
• casecross() argument, usefinalwindow now defaults to TRUE, not FALSE.