R/consec_pairs.R

Defines functions consec_pairs

Documented in consec_pairs

#' Generate a matrix of consecutive elements
#'
#' Given a vector, this function generates a two-column
#' matrix in which each row contains an element and its
#' consecutive neighbor.
#'
#' @param elements a vector of elements
#'
#' @return a matrix with two columns. The first column
#' is identical to elements with the last element taken
#' off. And second column holds the next consecutive 
#' element.
#'
#' @keywords internal
#' 
consec_pairs <- function(elements){
  
  pair_mat <- matrix(NA, nrow = (length(elements)-1), ncol = 2)
  pair_mat[,1] <- elements[1:(length(elements)-1)]
  pair_mat[,2] <- elements[2:length(elements)]
  return(pair_mat)
}

Try the cape package in your browser

Any scripts or data that you put into this service are public.

cape documentation built on Feb. 10, 2021, 5:06 p.m.