_pkgdown.yml

url: https://github.com/rpahl/container


template:
  bootstrap: 5
  bootswatch: cerulean

authors:
  Roman Pahl:
    href: https://rpahl.github.io/r-some-blog/about.html

home:
  links:
  - text: Visit my R blog
    href: https://rpahl.github.io/r-some-blog/
  - text: Visit my R packages universe
    href: https://rpahl.r-universe.dev/packages/

reference:
  - title: "Container"
    desc: "A container can be considered a base R list with extended functionality."
    contents:
    - Container
    - container
    - clear
    - clone
    - container_options
    - unpack
  - subtitle: "add or replace"
    contents:
    - add
    - starts_with("replace")
    - "[<-.Container"
  - subtitle: "extract"
    contents:
    - starts_with("at")
    - starts_with("peek_at")
    - "[.Container"
  - subtitle: "inspect"
    contents:
    - count
    - has
    - has_name
    - is_empty
  - subtitle: "remove"
    contents:
    - starts_with("delete")
    - starts_with("discard")
    - contains("pop")
  - subtitle: "update"
    contents:
    - rename
    - update

  - title: "Deque"
    desc: >
        Derives all Container methods.
        Can also be used to mimic stacks or simple queues.
    contents:
    - Deque
    - deque
    - addleft
    - peekleft
    - rev
    - rotate

  - title: "Set, OrderedSet"
    desc: >
        Derives all Container methods. Set elements are always unique.
    contents:
    - Set
    - OrderedSet
    - setnew


  - title: "Dict"
    desc: >
        Derives all Container methods. All Dict elements must be named and are
        always sorted by their name.
    contents:
    - Dict
    - dict


  - title: "dict.table"
    desc: >
        The dict.table is a mix of a dict and a data.table and derives
        all data.table and most of the dict/container methods.
    contents:
    - starts_with("dict.table")

  - title: "Iterator"
    desc: "Iterate over sequences."
    contents:
    - Iterable
    - Iterator
    - iter

  - title: "Operators"
    contents:
    - "+.Container"
    - "<.Container"
    - "&.Dict"

  - title: "Depecated"
    desc: "Deprecated functions."
    contents:
    - "deprecated"

news:
  releases:
  - text: "Version 1.0.0"
    href: https://rpahl.github.io/r-some-blog/posts/container1.0/

navbar:
  structure:
    left: [home, getStarted, reference, news, articles]
    right: [github, stackoverflow, bluesky, blog]

  components:
    home:
      icon: fa-home fa-lg
      href: index.html
      aria-label: home
    getStarted:
      text: "Get Started"
      href: articles/v01-interactive-usage.html

    articles:
      text: "Articles"
      menu:
        - text: "Overview"
          href: articles/index.html
        - text: "---"
        - text: "Get started"
        - text: "Use container in interactive session"
          href: articles/v01-interactive-usage.html
        - text: "Use container for code development"
          href: articles/v02-code-development.html
        - text: "Manage parameter lists with dict"
          href: articles/v03-parameter-list.html
        - text: "Manage data columns with dict.table"
          href: articles/v04-manage-data-columns.html
        - text: "---"
        - text: "Other"
        - text: "Deque, Set, and Dict"
          href: articles/v05-deque-set-dict.html
        - text: "Reference semantics"
          href: articles/v06-reference-semantics.html

    github:
      icon: fab fa-github
      href: https://github.com/rpahl/container/
      aria-label: github
    stackoverflow:
      icon: fab fa-stack-overflow
      href: https://stackoverflow.com/users/8120617/rpahl
      aria-label: stackoverflow
    bluesky:
      icon: fab fa-bluesky
      href: https://bsky.app/profile/rpahl.bsky.social
      aria-label: bluesky
    blog:
      icon: fas fa-blog
      href: https://rpahl.github.io/r-some-blog/
      aria-label: blog