summarise_along_walk.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/sims.R
\name{summarise_along_walk}
\alias{summarise_along_walk}
\title{Summarise every n numbers in a vector}
\source{
This function is a slight modification of the code provided here: https://stackoverflow.com/questions/43635846/calculating-mean-for-every-n-values-from-a-vector.
}
\usage{
summarise_along_walk(vec, every, summarise = sum, na.rm = FALSE, ...)
}
\arguments{
\item{vec}{A numeric vector.}

\item{every}{An integer that defines the step length of the walk over the vector.}

\item{summarise}{A function that summarises the numbers in each step.}

\item{na.rm}{A logical value that defines whether or not to remove NAs.}

\item{...}{Additional arguments passed to \code{summarise}.}
}
\value{
The function returns a numeric vector.
}
\description{
This function summarises every n numbers in a vector.
}
\examples{
\dontrun{
x <- c(rep(1, 10), rep(2, 10))
summarise_along_walk(x, every = 10)
x <- c(mean(10, 5), mean(100, 5))
summarise_along_walk(x, every = 10, summarise = mean)
x <- c(x, NA)
summarise_along_walk(x, every = 10, summarise = mean, na.rm = TRUE)
}

}
\keyword{internal}