Skip to content

Commit

Permalink
Set roll_middle() examples as dontrun
Browse files Browse the repository at this point in the history
R CMD CHECK expects all examples to work with exported functions
and fails for internal functions with documented examples.
  • Loading branch information
allenbaron committed Nov 2, 2024
1 parent f37d045 commit 804caee
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions R/utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -291,10 +291,12 @@ glueV <- function(..., .envir = parent.frame()) {
#'
#' @returns A numeric vector of middle values of the same length as `x`.
#' @examples
#' \dontrun{
#' x <- c(7, 14, 21, 25)
#'
#' roll_middle(x, 0, "min")
#' roll_middle(x, 30, "max")
#' }
#'
#' @section Notes:
#' An alternative function that produces the same result when the `limit` is
Expand Down
2 changes: 2 additions & 0 deletions man/roll_middle.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 804caee

Please sign in to comment.