_pkgdown.yml

url: https://mc-stan.org/posterior

destination: docs

development:
  mode: auto

template:
  params:
    bootswatch: cosmo

navbar:
  title: "posterior"
  left:
    - icon: fa-home fa-lg
      href: index.html
    - text: "Vignettes"
      href: articles/index.html
    - text: "Functions"
      href: reference/index.html
    - text: "News"
      href: news/index.html
    - text: "Other Packages"
      menu:
        - text: "rstan"
          href: https://mc-stan.org/rstan
        - text: "cmdstanr"
          href: https://mc-stan.org/cmdstanr
        - text: "rstanarm"
          href: https://mc-stan.org/rstanarm
        - text: "bayesplot"
          href: https://mc-stan.org/bayesplot
        - text: "shinystan"
          href: https://mc-stan.org/shinystan
        - text: "loo"
          href: https://mc-stan.org/loo
        - text: "projpred"
          href: https://mc-stan.org/projpred
        - text: "rstantools"
          href: https://mc-stan.org/rstantools
    - text: "Stan"
      href: https://mc-stan.org
  right:
   - icon: fa-twitter
     href: https://twitter.com/mcmc_stan
   - icon: fa-github
     href: https://github.com/stan-dev/posterior
   - icon: fa-users
     href: https://discourse.mc-stan.org/

home:
  links:
  - text: Ask a question
    href: https://discourse.mc-stan.org/


articles:
  - title: "Getting started"
    desc: >
      Installing posterior and using the basic functionality
    contents:
      - posterior
  - title: "rvar: The Random Variable Datatype"
    desc: >
      An overview of a new datatype introduced by posterior
    contents:
      - rvar
  - title: "Pareto-khat diagnostics"
    desc: >
      An overview of diagnostics related to Pareto-smoothed importance sampling
    contents:
      - pareto_diagnostics

reference:
  - title: "Overview"
    desc: >
      Pacakge overview and global options
    contents:
      - posterior-package
  - title: "Draws objects and formats"
    desc: >
      Create`draws` objects and convert between supported formats
    contents:
      - starts_with("as_draws")
      - starts_with("print")
      - variables # will include everything from draws-index.R
      - example_draws
      - reserved_variables
  - title: "Working with draws objects"
    desc: >
      Functions for modifying `draws` objects and extracting their contents
    contents:
      - bind_draws
      - starts_with("extract")
      - merge_chains
      - mutate_variables
      - set_variables
      - order_draws
      - split_chains
      - subset_draws
      - draws-index
      - rename_variables
      - repair_draws
      - resample_draws
      - thin_draws
      - weight_draws
      - weights.draws
  - title: "Summarizing and diagnosing draws objects"
    desc: >
      Compute summary statistics and convergence diagnostics
    contents:
      - summarise_draws
      - diagnostics
      - starts_with("ess")
      - starts_with("rhat")
      - starts_with("mcse")
      - starts_with("pareto")
      - starts_with("ps")
      - quantile2
      - rstar
      - entropy
      - dissent
      - modal_category
  - title: "Functionality specific to the rvar datatype"
    desc: >
      The `draws_rvar` format (a structured list of `rvar` objects) has the same
      methods (e.g. `bind_draws()`) as the other draws formats. For individual
      `rvar` objects themselves, however, posterior provides additional
      functionality.
    contents:
      - chol.rvar
      - starts_with("rvar")
      - is_rvar
      - is_rvar_factor
      - as_rvar
      - as_rvar_factor
      - rdo
      - rfun
      - draws_of
      - diag,rvar-method
      - drop,rvar-method
      - for_each_draw
      - match