_pkgdown.yml

url: https://mjskay.github.io/ggdist


template:
  bootstrap: 5
  params:
    ganalytics: UA-93322-5
  bslib:
    line-height-base: 1.7
    primary: "#4575B4"
    base_font:
      google:
        family: "Source Sans Pro"
        wght: [400, 600, 700]
        ital: [0, 1]
    code_font:
      google:
        family: "Source Code Pro"
        wght: [400, 700]
        ital: [0, 1]


authors:
  Matthew Kay:
    href: https://www.mjskay.com


reference:
- title: "Package overview"
  contents:
  - ggdist-package

- title: "Stats and Geoms for visualizing distributions with ggplot2"
  desc: >
    These `{ggplot2}` layers are split into two categories: `stat`s for
    visualizing sample data and distribution vectors, and the underlying
    `geom`s for visualizing already-summarized data (e.g., intervals or
    density values).

- subtitle: "Stats for visualizing sample data and distribution vectors"
  desc: >
    `stat`s for visualizing tidy data frames of draws (e.g. sample data,
    draws from a bootstrap distributation, draws from a Bayesian posterior) and
    distribution vectors (such as `{distributional}` objects and `posterior::rvar()`s).
  contents:
  - stat_slabinterval
  - stat_pointinterval
  - stat_interval
  - stat_slab
  - stat_halfeye
  - stat_eye
  - stat_ccdfinterval
  - stat_cdfinterval
  - stat_gradientinterval
  - stat_histinterval
  - stat_spike
  - stat_dotsinterval
  - stat_dots
  - stat_mcse_dots
  - stat_lineribbon
  - stat_ribbon

- subtitle: "Geoms for visualizing already-summarized data"
  desc: >
    `geom`s for visualizing data that has already been summarized (e.g.
    into density function values, points, intervals, etc).
  contents:
  - geom_slabinterval
  - geom_pointinterval
  - geom_interval
  - geom_slab
  - geom_spike
  - geom_dotsinterval
  - geom_dots
  - geom_blur_dots
  - geom_weave
  - geom_swarm
  - geom_lineribbon

- title: "Point summaries and intervals"
  desc: >
    Functions to calculate point summaries and intervals on tidy data.
    These functions can be used directly on vectors, on data frames of draws,
    on distribution vectors (such as `{distributional}` objects and
    `posterior::rvar()`s), and in `{ggdist}` `stat`s and `geom`s to determine
    what point summaries and intervals are drawn.
  contents:
  - point_interval
  - curve_interval
  - Mode
  - ends_with("hdci")
  - ends_with("hdi")
  - ends_with("qi")
  - cut_cdf_qi

- title: "Distributions"
  desc: >
    Helper functions for manipulating and visualizing analytical distributions.
  contents:
  - parse_dist
  - student_t
  - lkjcorr_marginal
  - marginalize_lkjcorr

- title: "ggplot2 components"
  desc: >
    `{ggplot2}` scales, positions, sub-guides, and themes designed for use
    with `{ggdist}` `stat`s and `geom`s.

- subtitle: "Scales and sub-scales"
  desc: >
    Scales for custom aesthetics used by `{ggdist}` geoms and stats, such
    as `thickness`, `colour_ramp`, and `side`, as well as sub-geometry-specific
    aesthetics, such as `slab_colour`, `point_size`, etc.
  contents:
  - scale_thickness
  - subscale_thickness
  - scale_colour_ramp
  - scale_side_mirrored
  - sub-geometry-scales
  - partial_colour_ramp
  - ramp_colours

- subtitle: "Positions"
  desc: >
    Positions for dodging `geom`s and `stat`s.
  contents:
  - position_dodgejust

- subtitle: "Guides and sub-guides"
  desc: >
    Guide for labeling the `colour_ramp` and `fill_ramp` scales, and
    sub-guides for labelling the `thickness` axis in `geom_slab()` and
    dot counts in `geom_dots()`.
  contents:
  - guide_rampbar
  - starts_with("subguide_")

- subtitle: "Themes"
  desc: >
    `{ggdist}` theme and helper functions for `{ggplot2}`.
  contents:
  - theme_ggdist
  - facet_title_left_horizontal
  - facet_title_right_horizontal
  - axis_titles_bottom_left

- title: "Estimators and algorithms"
  desc: >
    Modular and configurable estimators and algorithms used by a variety of
    `stat`s and `geom`s. Many of these functions use automatic partial function
    application (aka "currying") provided by `auto_partial()`.
  contents:
  - automatic-partial-functions

- subtitle: "Dotplot layout algorithms"
  desc: >
    Algorithms used by `geom_dotsinterval()` for automatically determining
    nice-looking dotplot binwidths and laying out dots.
  contents:
  - find_dotplot_binwidth
  - bin_dots

- subtitle: "Dotplot smoothers"
  desc: >
    Smoothers for creating "density dotplots" using `geom_dotsinterval()`.
  contents:
  - smooth_density
  - smooth_discrete
  - smooth_none

- subtitle: "Density estimators"
  desc: >
    Density functions used by `stat_slabinterval()` and by the density
    smoothers for dotplot layout.
  contents:
  - density_bounded
  - density_unbounded
  - density_histogram

- subtitle: "Bandwidth estimators"
  desc: >
    Bandwidth estimators for use with `density_unbounded()` and `density_bounded()`.
  contents:
  - bandwidth

- subtitle: "Distribution bounds estimators"
  desc: >
    Distribution bounds estimators for use with `density_bounded()`.
  contents:
  - bounder_cdf
  - bounder_cooke
  - bounder_range

- subtitle: "Histogram layout algorithms"
  desc: >
    Algorithms for bin selection and alignment for use with `density_histogram()`.
  contents:
  - breaks
  - align

- subtitle: "Blur functions"
  desc: >
    Blur functions for use with `geom_blur_dots()`.
  contents:
  - blur

- subtitle: "Weighted quantiles and CDFs"
  desc: >
    Weighted generalizations of `quantile()` and `ecdf()` used internally by
    several algorithms.
  contents:
  - weighted_quantile
  - weighted_ecdf

- title: "Probability expressions"
  desc: >
    Experimental mini-domain-specific language for probability expressions
    in `stat_slabinterval()` aesthetics.
  contents:
  - Pr_
  - p_

- title: "Compatibility with other packages"
  desc: >
    Functions to convert the ggdist naming scheme (for `point_interval()`) to
    and from other packages' naming schemes.
  contents:
  - to_broom_names
  - from_broom_names
  - to_ggmcmc_names
  - from_ggmcmc_names

- title: "Datasets"
  desc: >
    Datasets used for examples and testing
  contents:
  - RankCorr

- title: "Deprecated functions"
  contents:
  - ggdist-deprecated