_pkgdown.yml

url: https://purrr.tidyverse.org

template:
  package: tidytemplate
  bootstrap: 5

  includes:
    in_header: |
      <script defer data-domain="purrr.tidyverse.org,all.tidyverse.org" src="https://plausible.io/js/plausible.js"></script>

development:
  mode: auto

home:
  links:
  - text: Learn more
    href: http://r4ds.had.co.nz/iteration.html

news:
  releases:
  - text: "Version 1.0.0"
    href: https://www.tidyverse.org/blog/2022/12/purrr-1-0-0/
  - text: "Version 0.3.0"
    href: https://www.tidyverse.org/articles/2019/02/purrr-0-3-0/
  - text: "Version 0.2.3"
    href: https://www.tidyverse.org/articles/2017/08/purrr-0.2.3/

reference:
- title: Map family
  desc: |
    The `map(.x, .f)` functions transforms each element of the vector `.x` with
    the function `.f`, returning a vector defined by the suffix (`_lgl`,
    `_chr()` etc). `walk()` is a variant for functions called primarily for
    their side-effects; it returns `.x` invisibly.

    As well as functions, `.f`, can take numbers and characters (used as a
    shorthand for `[[`), and formulas (used as a succint function definition).
    See details in `as_mapper()`
  contents:
  - map
  - as_mapper

- title: Map variants
  desc: >
    A rich set of variants builds on the basic idea of `map()`:
    `modify()` modifies "in place", returning a vector the same type as `.x`;
    `map2()` iterates over two vectors in parallel;
    `pmap()` (parallel map) iterates over a list of vectors;
    `imap()` (index map) is a shortcut for the common pattern `map2(x, names(x))`.
  contents:
  - map_if
  - map_depth
  - map2
  - pmap
  - modify
  - modify_tree
  - imap
  - lmap

- title: Predicate functionals
  desc: >
    A predicate function is a function that either returns `TRUE` or `FALSE`.
    The predicate functionals take a vector and a predicate function and do
    something useful.
  contents:
  - detect
  - every
  - has_element
  - head_while
  - keep
  - keep_at

- title: Plucking
  desc: >
    Getting or setting a single element.
  contents:
  - pluck
  - chuck
  - pluck_depth
  - modify_in
  - attr_getter

- title: Other vector transforms
  desc: >
    A grab bag of useful tools for manipulating vectors.
  contents:
  - accumulate
  - list_c
  - list_flatten
  - list_modify
  - list_simplify
  - list_transpose
  - reduce

- title: Superseded
  description: |
     Superseded functions have been replaced by superior solutions, but
     due to their widespread use will not go away. However, they will not
     get any new features and will only receive critical bug fixes.
  contents:
  - flatten
  - map_df
  - simplify
  - transpose

- title: Adverbs
  desc: >
    Adverbs modify the action of a function; they take a function as input and
    return a function with modified action as output.
  contents:
  - has_concept("adverbs")

- title: Misc
  contents:
  - array_tree
  - rate-helpers
  - progress_bars