Nothing
#' Slide along multiples inputs simultaneously relative to an index
#'
#' `slide_index2()` and `pslide_index()` represent the combination
#' of [slide2()] and [pslide()] with [slide_index()], allowing you to iterate
#' over multiple vectors at once relative to an `.i`-ndex.
#'
#' @inheritParams slide_index
#'
#' @template param-x-y
#' @template param-l
#' @template param-before-after-slide-index
#'
#' @return
#' A vector fulfilling the following invariants:
#'
#' \subsection{`slide_index2()`}{
#'
#' * `vec_size(slide_index2(.x, .y)) == vec_size_common(.x, .y)`
#'
#' * `vec_ptype(slide_index2(.x, .y)) == list()`
#'
#' }
#'
#' \subsection{`slide_index2_vec()` and `slide_index2_*()` variants}{
#'
#' * `vec_size(slide_index2_vec(.x, .y)) == vec_size_common(.x, .y)`
#'
#' * `vec_size(slide_index2_vec(.x, .y)[[1]]) == 1L`
#'
#' * `vec_ptype(slide_index2_vec(.x, .y, .ptype = ptype)) == ptype`
#'
#' }
#'
#' \subsection{`pslide_index()`}{
#'
#' * `vec_size(pslide_index(.l)) == vec_size_common(!!! .l)`
#'
#' * `vec_ptype(pslide_index(.l)) == list()`
#'
#' }
#'
#' \subsection{`pslide_index_vec()` and `pslide_index_*()` variants}{
#'
#' * `vec_size(pslide_index_vec(.l)) == vec_size_common(!!! .l)`
#'
#' * `vec_size(pslide_index_vec(.l)[[1]]) == 1L`
#'
#' * `vec_ptype(pslide_index_vec(.l, .ptype = ptype)) == ptype`
#'
#' }
#'
#' @examples
#' # Notice that `i` is an irregular index!
#' x <- 1:5
#' y <- 6:10
#' i <- as.Date("2019-08-15") + c(0:1, 4, 6, 7)
#'
#' # When we slide over `i` looking back 1 day, the irregularity is respected.
#' # When there is a gap in dates, only 2 values are returned (one from
#' # `x` and one from `y`), otherwise, 4 values are returned.
#' slide_index2(x, y, i, ~c(.x, .y), .before = 1)
#'
#' @seealso [slide2()], [hop_index2()], [slide_index()]
#' @export
slide_index2 <- function(.x,
.y,
.i,
.f,
...,
.before = 0L,
.after = 0L,
.complete = FALSE) {
slide_index2_impl(
.x,
.y,
.i,
.f,
...,
.before = .before,
.after = .after,
.complete = .complete,
.ptype = list(),
.constrain = FALSE,
.atomic = FALSE
)
}
#' @rdname slide_index2
#' @export
slide_index2_vec <- function(.x,
.y,
.i,
.f,
...,
.before = 0L,
.after = 0L,
.complete = FALSE,
.ptype = NULL) {
out <- slide_index2_impl(
.x,
.y,
.i,
.f,
...,
.before = .before,
.after = .after,
.complete = .complete,
.ptype = list(),
.constrain = FALSE,
.atomic = TRUE
)
vec_simplify(out, .ptype)
}
slide_index2_vec_direct <- function(.x,
.y,
.i,
.f,
...,
.before,
.after,
.complete,
.ptype,
.slider_error_call = caller_env()) {
slide_index2_impl(
.x,
.y,
.i,
.f,
...,
.before = .before,
.after = .after,
.complete = .complete,
.ptype = .ptype,
.constrain = TRUE,
.atomic = TRUE,
.slider_error_call = .slider_error_call
)
}
#' @rdname slide_index2
#' @export
slide_index2_dbl <- function(.x,
.y,
.i,
.f,
...,
.before = 0L,
.after = 0L,
.complete = FALSE) {
slide_index2_vec_direct(
.x,
.y,
.i,
.f,
...,
.before = .before,
.after = .after,
.complete = .complete,
.ptype = double()
)
}
#' @rdname slide_index2
#' @export
slide_index2_int <- function(.x,
.y,
.i,
.f,
...,
.before = 0L,
.after = 0L,
.complete = FALSE) {
slide_index2_vec_direct(
.x,
.y,
.i,
.f,
...,
.before = .before,
.after = .after,
.complete = .complete,
.ptype = integer()
)
}
#' @rdname slide_index2
#' @export
slide_index2_lgl <- function(.x,
.y,
.i,
.f,
...,
.before = 0L,
.after = 0L,
.complete = FALSE) {
slide_index2_vec_direct(
.x,
.y,
.i,
.f,
...,
.before = .before,
.after = .after,
.complete = .complete,
.ptype = logical()
)
}
#' @rdname slide_index2
#' @export
slide_index2_chr <- function(.x,
.y,
.i,
.f,
...,
.before = 0L,
.after = 0L,
.complete = FALSE) {
slide_index2_vec_direct(
.x,
.y,
.i,
.f,
...,
.before = .before,
.after = .after,
.complete = .complete,
.ptype = character()
)
}
#' @inheritParams vctrs::vec_rbind
#' @rdname slide_index2
#' @export
slide_index2_dfr <- function(.x,
.y,
.i,
.f,
...,
.before = 0L,
.after = 0L,
.complete = FALSE,
.names_to = rlang::zap(),
.name_repair = c("unique", "universal", "check_unique")) {
out <- slide_index2(
.x,
.y,
.i,
.f,
...,
.before = .before,
.after = .after,
.complete = .complete
)
vec_rbind(!!!out, .names_to = .names_to, .name_repair = .name_repair)
}
#' @inheritParams vctrs::vec_cbind
#' @rdname slide_index2
#' @export
slide_index2_dfc <- function(.x,
.y,
.i,
.f,
...,
.before = 0L,
.after = 0L,
.complete = FALSE,
.size = NULL,
.name_repair = c("unique", "universal", "check_unique", "minimal")) {
out <- slide_index2(
.x,
.y,
.i,
.f,
...,
.before = .before,
.after = .after,
.complete = .complete
)
vec_cbind(!!!out, .size = .size, .name_repair = .name_repair)
}
# ------------------------------------------------------------------------------
slide_index2_impl <- function(.x,
.y,
.i,
.f,
...,
.before,
.after,
.complete,
.ptype,
.constrain,
.atomic,
.slider_error_call = caller_env()) {
vec_assert(.x, call = .slider_error_call)
vec_assert(.y, call = .slider_error_call)
.f <- as_function(.f, call = .slider_error_call)
args <- vec_recycle_common(.x = .x, .y = .y, .call = .slider_error_call)
f_call <- expr(.f(.x, .y, ...))
type <- -2L
slide_index_common(
x = args,
i = .i,
f_call = f_call,
before = .before,
after = .after,
complete = .complete,
ptype = .ptype,
constrain = .constrain,
atomic = .atomic,
env = environment(),
type = type,
slider_error_call = .slider_error_call
)
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.