From 8ceb516b16c84caa5718ba7345c348012f7346d3 Mon Sep 17 00:00:00 2001 From: VP Nagraj Date: Tue, 10 Oct 2023 14:04:13 -0400 Subject: [PATCH] no longer documenting observed signal as option for plane_trend --- R/planes.R | 2 +- man/plane_trend.Rd | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/R/planes.R b/R/planes.R index 5572db2..45c8d66 100644 --- a/R/planes.R +++ b/R/planes.R @@ -506,7 +506,7 @@ plane_score <- function(input, seed, components = "all", args = NULL) { #' This function identifies any change points in the forecast data or in the final observed data point. Change points are identified by any significant change in magnitude or direction of the slope of the time series. #' #' @param location Character vector with location code; the location must appear in input and seed -#' @param input Input signal data to be scored; object must be one of [forecast][to_signal()] or [observed][to_signal()] +#' @param input Input signal data to be scored; object must be [forecast][to_signal()] #' @param seed Prepared [seed][plane_seed()] #' @param sig_lvl The significance level at which to identify change points (between zero and one); default is 0.1 #' diff --git a/man/plane_trend.Rd b/man/plane_trend.Rd index 19031ba..275cc74 100644 --- a/man/plane_trend.Rd +++ b/man/plane_trend.Rd @@ -9,7 +9,7 @@ plane_trend(location, input, seed, sig_lvl = 0.1) \arguments{ \item{location}{Character vector with location code; the location must appear in input and seed} -\item{input}{Input signal data to be scored; object must be one of \link[=to_signal]{forecast} or \link[=to_signal]{observed}} +\item{input}{Input signal data to be scored; object must be \link[=to_signal]{forecast}} \item{seed}{Prepared \link[=plane_seed]{seed}}