Add a posterior analysis function to R (#238)

* Add a posterior analysis function to R

* Add a predictive_samples function to R
This commit is contained in:
Simon Kim 2017-07-04 17:27:55 -07:00 committed by Ben Letham
parent b3017c025f
commit 19e95311c2
4 changed files with 62 additions and 12 deletions

View file

@ -1,9 +1,10 @@
# Generated by roxygen2: do not edit by hand # Generated by roxygen2: do not edit by hand
S3method(plot,prophet)
S3method(predict,prophet) S3method(predict,prophet)
export(fit.prophet) export(fit.prophet)
export(make_future_dataframe) export(make_future_dataframe)
export(plot.prophet)
export(predictive_samples)
export(prophet) export(prophet)
export(prophet_plot_components) export(prophet_plot_components)
import(Rcpp) import(Rcpp)

View file

@ -768,14 +768,14 @@ predict_seasonal_components <- function(m, df) {
return(component.predictions) return(component.predictions)
} }
#' Prophet uncertainty intervals. #' Prophet posterior predictive samples.
#' #'
#' @param m Prophet object. #' @param m Prophet object.
#' @param df Prediction dataframe. #' @param df Prediction dataframe.
#' #'
#' @return Dataframe with uncertainty intervals. #' @return List with posterior predictive samples for each component.
#' #'
predict_uncertainty <- function(m, df) { sample_posterior_predictive <- function(m, df) {
# Sample trend, seasonality, and yhat from the extrapolation model. # Sample trend, seasonality, and yhat from the extrapolation model.
n.iterations <- length(m$params$k) n.iterations <- length(m$params$k)
samp.per.iter <- max(1, ceiling(m$uncertainty.samples / n.iterations)) samp.per.iter <- max(1, ceiling(m$uncertainty.samples / n.iterations))
@ -797,7 +797,18 @@ predict_uncertainty <- function(m, df) {
} }
} }
} }
return(sim.values)
}
#' Prophet uncertainty intervals.
#'
#' @param m Prophet object.
#' @param df Prediction dataframe.
#'
#' @return Dataframe with uncertainty intervals.
#'
predict_uncertainty <- function(m, df) {
sim.values <- sample_posterior_predictive(m, df)
# Add uncertainty estimates # Add uncertainty estimates
lower.p <- (1 - m$interval.width)/2 lower.p <- (1 - m$interval.width)/2
upper.p <- (1 + m$interval.width)/2 upper.p <- (1 + m$interval.width)/2
@ -816,6 +827,7 @@ predict_uncertainty <- function(m, df) {
return(intervals) return(intervals)
} }
#' Simulate observations from the extrapolated generative model. #' Simulate observations from the extrapolated generative model.
#' #'
#' @param m Prophet object. #' @param m Prophet object.
@ -1163,4 +1175,20 @@ plot_yearly <- function(m, uncertainty = TRUE, yearly_start = 0) {
return(gg.yearly) return(gg.yearly)
} }
#' Sample from the posterior predictive distribution.
#'
#' @param m Prophet object.
#' @param df Dataframe with dates for predictions (column ds), and capacity
#' (column cap) if logistic growth.
#'
#' @return A list with items "trend", "seasonal", and "yhat" containing
#' posterior predictive samples for that component.
#'
#' @export
predictive_samples <- function(m, df) {
df <- setup_dataframe(m, df)$df
sim.values <- sample_posterior_predictive(m, df)
return(sim.values)
}
# fb-block 3 # fb-block 3

View file

@ -4,8 +4,8 @@
\alias{plot.prophet} \alias{plot.prophet}
\title{Plot the prophet forecast.} \title{Plot the prophet forecast.}
\usage{ \usage{
\method{plot}{prophet}(x, fcst, uncertainty = TRUE, plot_cap = TRUE, plot.prophet(x, fcst, uncertainty = TRUE, plot_cap = TRUE, xlabel = "ds",
xlabel = "ds", ylabel = "y", ...) ylabel = "y", ...)
} }
\arguments{ \arguments{
\item{x}{Prophet object.} \item{x}{Prophet object.}

View file

@ -0,0 +1,21 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/prophet.R
\name{predictive_samples}
\alias{predictive_samples}
\title{Sample from the posterior predictive distribution.}
\usage{
predictive_samples(m, df)
}
\arguments{
\item{m}{Prophet object.}
\item{df}{Dataframe with dates for predictions (column ds), and capacity
(column cap) if logistic growth.}
}
\value{
A list with items "trend", "seasonal", and "yhat" containing
posterior predictive samples for that component.
}
\description{
Sample from the posterior predictive distribution.
}