setup_dataframe.Rd 721 B

1234567891011121314151617181920212223242526
  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/prophet.R
  3. \name{setup_dataframe}
  4. \alias{setup_dataframe}
  5. \title{Prepare dataframe for fitting or predicting.}
  6. \usage{
  7. setup_dataframe(m, df, initialize_scales = FALSE)
  8. }
  9. \arguments{
  10. \item{m}{Prophet object.}
  11. \item{df}{Data frame with columns ds, y, and cap if logistic growth. Any
  12. specified additional regressors must also be present.}
  13. \item{initialize_scales}{Boolean set scaling factors in m from df.}
  14. }
  15. \value{
  16. list with items 'df' and 'm'.
  17. }
  18. \description{
  19. Adds a time index and scales y. Creates auxillary columns 't', 't_ix',
  20. 'y_scaled', and 'cap_scaled'. These columns are used during both fitting
  21. and predicting.
  22. }
  23. \keyword{internal}