2017-08-30 23:17:41 +00:00
|
|
|
% Generated by roxygen2: do not edit by hand
|
2018-06-15 01:42:11 +00:00
|
|
|
% Please edit documentation in R/plot.R
|
2017-08-30 23:17:41 +00:00
|
|
|
\name{plot_forecast_component}
|
|
|
|
|
\alias{plot_forecast_component}
|
|
|
|
|
\title{Plot a particular component of the forecast.}
|
|
|
|
|
\usage{
|
2020-02-27 20:19:34 +00:00
|
|
|
plot_forecast_component(m, fcst, name, uncertainty = TRUE, plot_cap = FALSE)
|
2017-08-30 23:17:41 +00:00
|
|
|
}
|
|
|
|
|
\arguments{
|
2018-05-15 17:07:38 +00:00
|
|
|
\item{m}{Prophet model}
|
|
|
|
|
|
2017-08-30 23:17:41 +00:00
|
|
|
\item{fcst}{Dataframe output of `predict`.}
|
|
|
|
|
|
|
|
|
|
\item{name}{String name of the component to plot (column of fcst).}
|
|
|
|
|
|
2020-02-10 03:31:44 +00:00
|
|
|
\item{uncertainty}{Optional boolean to plot uncertainty intervals, which will
|
|
|
|
|
only be done if m$uncertainty.samples > 0.}
|
2017-08-30 23:17:41 +00:00
|
|
|
|
|
|
|
|
\item{plot_cap}{Boolean indicating if the capacity should be shown in the
|
|
|
|
|
figure, if available.}
|
|
|
|
|
}
|
|
|
|
|
\value{
|
|
|
|
|
A ggplot2 plot.
|
|
|
|
|
}
|
|
|
|
|
\description{
|
|
|
|
|
Plot a particular component of the forecast.
|
|
|
|
|
}
|