104 add plane shape to individual components vignette

R/planes.R

@@ -421,7 +421,7 @@ plane_repeat <- function(location, input, seed, tolerance = NULL, prepend = NULL
 #' plane_score(input = prepped_forecast, seed = prepped_seed, components = c("cover","taper"))
 #'
 #' ## run plane scoring with all components and additional args
-#' comp_args <- list(trend = list(sig_lvl = 0.05), repeat = list(prepend = 4, tolerance = 8))
+#' comp_args <- list("trend" = list("sig_lvl" = 0.05), "repeat" = list("prepend" = 4, "tolerance" = 8))
 #' plane_score(input = prepped_forecast, seed = prepped_seed, args = comp_args)
 #' }
 plane_score <- function(input, seed, components = "all", args = NULL) {
@@ -868,7 +868,7 @@ plane_shape <- function(location, input, seed) {
 #'
 #' @description
 #'
-#' This function checks for the presence of any value(s) equal to zero in the evaluated signal. If there are any zeros found then, the function will internally assess the [seed][plane_seed()] to find whether or not the input data had zeros anywhere else in the time series. If so, the function will consider the evaluated zero plausible and no flagged will be raised (i.e., indicator returned as `FALSE`). If not, the function will consider the evaluated zero implausible and a flagged will be raised (i.e., indicator returned as `TRUE`).
+#' This function checks for the presence of any value(s) equal to zero in the evaluated signal. If there are any zeros found, then the function will internally assess the [seed][plane_seed()] to find whether or not the input data had zeros anywhere else in the time series. If so, the function will consider the evaluated zero plausible and no flag will be raised (i.e., indicator returned as `FALSE`). If not, the function will consider the evaluated zero implausible and a flag will be raised (i.e., indicator returned as `TRUE`).
 #'
 #' @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()]