R/flat-map2.R

In DavisVaughan/flatcat: What the Package Does (One Line, Title Case)

#' Flat map over multiple inputs simultaneously
#'
#' These functions are variants of [flat_map_vec()] that iterate over multiple
#' arguments simultaneously.
#'
#' @param .x,.y Vectors of the same length. A vector of length 1 will be
#'   recycled.
#'
#' @inheritParams purrr::map2
#' @inheritParams flat_map_vec
#'
#' @examples
#' # Interleave vectors (but this isn't that efficient)
#' flat_map2_dbl(1:5, 6:10, ~c(.x, .y))
#'
#' @name flat-map2
NULL

#' @rdname flat-map2
#' @export
flat_map2_vec <- function(.x,
                          .y,
                          .f,
                          ...,
                          .ptype = NULL,
                          .name_spec = NULL,
                          .name_repair = c("minimal", "unique", "check_unique", "universal")) {
  out <- map2(.x, .y, .f, ...)
  vec_c(!!! out, .ptype = .ptype, .name_spec = .name_spec, .name_repair = .name_repair)
}

#' @rdname flat-map2
#' @export
flat_map2_lst <- function(.x,
                          .y,
                          .f,
                          ...,
                          .name_spec = NULL,
                          .name_repair = c("minimal", "unique", "check_unique", "universal")) {
  flat_map2_vec(.x, .y, .f, ..., .ptype = list(), .name_spec = .name_spec, .name_repair = .name_repair)
}

#' @rdname flat-map2
#' @export
flat_map2_dbl <- function(.x,
                          .y,
                          .f,
                          ...,
                          .name_spec = NULL,
                          .name_repair = c("minimal", "unique", "check_unique", "universal")) {
  flat_map2_vec(.x, .y, .f, ..., .ptype = double(), .name_spec = .name_spec, .name_repair = .name_repair)
}

#' @rdname flat-map2
#' @export
flat_map2_int <- function(.x,
                          .y,
                          .f,
                          ...,
                          .name_spec = NULL,
                          .name_repair = c("minimal", "unique", "check_unique", "universal")) {
  flat_map2_vec(.x, .y, .f, ..., .ptype = integer(), .name_spec = .name_spec, .name_repair = .name_repair)
}

#' @rdname flat-map2
#' @export
flat_map2_chr <- function(.x,
                          .y,
                          .f,
                          ...,
                          .name_spec = NULL,
                          .name_repair = c("minimal", "unique", "check_unique", "universal")) {
  flat_map2_vec(.x, .y, .f, ..., .ptype = character(), .name_spec = .name_spec, .name_repair = .name_repair)
}

#' @rdname flat-map2
#' @export
flat_map2_lgl <- function(.x,
                          .y,
                          .f,
                          ...,
                          .name_spec = NULL,
                          .name_repair = c("minimal", "unique", "check_unique", "universal")) {
  flat_map2_vec(.x, .y, .f, ..., .ptype = logical(), .name_spec = .name_spec, .name_repair = .name_repair)
}

#' Flat map multiple inputs simultaneouly and convert to a data frame
#'
#' These functions are variants of [flat_map_dfr()] and [flat_map_dfc()] that
#' iterate over multiple arguments simultaneously.
#'
#' @param .x,.y Vectors of the same length. A vector of length 1 will be
#'   recycled.
#'
#' @inheritParams purrr::map2
#' @inheritParams flat_map_dfr
#'
#' @examples
#' flat_map2_dfr(list(1, 2:3), list(4, 5:6), ~data.frame(x = .x, y = .y))
#' @name flat-map2-df
NULL

#' @rdname flat-map2-df
#' @export
flat_map2_dfr <- function(.x,
                          .y,
                          .f,
                          ...,
                          .ptype = NULL,
                          .names_to = NULL,
                          .name_repair = c("unique", "universal", "check_unique")) {
  out <- map2(.x, .y, .f, ...)
  vec_rbind(!!! out, .ptype = .ptype, .names_to = .names_to, .name_repair = .name_repair)
}

#' @rdname flat-map2-df
#' @export
flat_map2_dfc <- function(.x,
                          .y,
                          .f,
                          ...,
                          .ptype = NULL,
                          .size = NULL,
                          .name_repair = c("unique", "universal", "check_unique", "minimal")) {
  out <- map2(.x, .y, .f, ...)
  vec_cbind(!!! out, .ptype = .ptype, .size = .size, .name_repair = .name_repair)
}