File: setup_dataframe.Rd

package info (click to toggle)
r-cran-prophet 1.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 736 kB
  • sloc: sh: 13; makefile: 2
file content (25 lines) | stat: -rw-r--r-- 721 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/prophet.R
\name{setup_dataframe}
\alias{setup_dataframe}
\title{Prepare dataframe for fitting or predicting.}
\usage{
setup_dataframe(m, df, initialize_scales = FALSE)
}
\arguments{
\item{m}{Prophet object.}

\item{df}{Data frame with columns ds, y, and cap if logistic growth. Any
specified additional regressors must also be present.}

\item{initialize_scales}{Boolean set scaling factors in m from df.}
}
\value{
list with items 'df' and 'm'.
}
\description{
Adds a time index and scales y. Creates auxillary columns 't', 't_ix',
'y_scaled', and 'cap_scaled'. These columns are used during both fitting
and predicting.
}
\keyword{internal}