From 62d457fa6aae136b95f7c78906e30b0c04132f79 Mon Sep 17 00:00:00 2001 From: "David J. Bosak" Date: Mon, 2 Oct 2023 21:35:59 -0400 Subject: [PATCH] Small doc updates. --- R/other_functions.R | 6 ++++-- docs/news/index.html | 2 +- docs/pkgdown.yml | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/R/other_functions.R b/R/other_functions.R index a6c092a..fd5540b 100644 --- a/R/other_functions.R +++ b/R/other_functions.R @@ -357,7 +357,7 @@ copy.attributes <- function(source, target) { #' data frame. The function is used to locate grouping boundaries. It will #' return a TRUE each time the current value is different from the previous #' value. The \code{changed} function is similar to the Base R \code{duplicated} -#' function, except \code{changed} the function will return TRUE even if +#' function, except the \code{changed} function will return TRUE even if #' the changed value is not unique. #' @details #' For a data frame, @@ -378,7 +378,9 @@ copy.attributes <- function(source, target) { #' the simplify option will return a single vector of indicator values #' instead of a data frame of indicator values. #' @returns A vector of TRUE or FALSE values indicating the grouping boundaries -#' of the vector or data frame. +#' of the vector or data frame. If the input data is a data frame and the +#' "simplify" parameter is FALSE, the return value will be a data frame +#' of logical vectors describing changed values for each column. #' @examples #' # Create sample vector #' v1 <- c(1, 1, 1, 2, 2, 3, 3, 3, 1, 1) diff --git a/docs/news/index.html b/docs/news/index.html index 91b8b4d..6a09315 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -51,7 +51,7 @@

Changelog

- +