_pkgdown.yml

url: https://jbengler.github.io/tidyplots/
template:
  bootstrap: 5

authors:
  Jan Broder Engler:
    href: https://github.com/jbengler

figures:
  dpi: 200
  fig.width: 4
  fig.height: 3

articles:
- title: Articles
  navbar: ~
  contents:
  - articles/Visualizing-data
  - articles/Advanced-plotting
  - articles/Color-schemes

reference:
- title:
  desc: >
    To create a plot, start with the `tidyplot()` function. Build the plot by adding, removing, and adjusting plot components. The `split_plot()` function must be called last in this sequence and can only be followed by `save_plot()`.
- title: Create
- contents:
  - tidyplot
- title: Add
  desc: Add plot components to represent data points, central tendency measures, dispersion and more.
- subtitle: Data points & amounts
- contents:
  - starts_with("add_data_points")
  - starts_with("add_count")
  - starts_with("add_sum")
  - starts_with("add_heatmap")
  - starts_with("add_line")
- subtitle: Central tendency
- contents:
  - starts_with("add_mean")
  - starts_with("add_median")
  - starts_with("add_curve_fit")
- subtitle: Distribution & uncertainty
- contents:
  - starts_with("add_histogram")
  - starts_with("add_boxplot")
  - starts_with("add_violin")
  - starts_with("add_sem")
- subtitle: Proportion
- contents:
  - starts_with("add_barstack")
  - starts_with("add_areastack")
  - starts_with("add_pie")
- subtitle: Statistical testing
- contents:
  - starts_with("add_test")
- subtitle: Annotation
- contents:
  - starts_with("add_title")
  - starts_with("add_data_labels")
  - starts_with("add_reference")
- title: Remove
  desc: Remove plot components.
- contents:
  - starts_with("remove")
- title: Adjust
  desc: Adjust plot components, properties, and data labels.
- subtitle: Components & properties
- contents:
  - starts_with("adjust_colors")
  - starts_with("adjust_font")
  - starts_with("adjust_legend")
  - starts_with("adjust_title")
  - starts_with("adjust_size")
  - starts_with("adjust_padding")
  - starts_with("adjust_x_axis")
- subtitle: Axis and color labels
- contents:
  - starts_with("rename")
  - starts_with("reorder")
  - starts_with("sort")
  - starts_with("reverse")
- title: Themes
  desc: Finetune the look of the plot.
- contents:
  - starts_with("theme")
  - starts_with("adjust_theme")
- title: Color schemes
  desc: Choose from a wide range of color schemes.
- contents:
  - starts_with("colors_discrete")
  - starts_with("colors_continuous")
  - starts_with("colors_diverging")
  - starts_with("new_color_scheme")
- title: Split
  desc: Split the plot into a multi plot layout, eventually across multiple pages.
- contents:
  - split_plot
- title: Output
  desc: Output the final plot or intermediate stages to the screen or to a file.
- contents:
  - view_plot
  - save_plot
- title: Helpers
- contents:
  - ends_with("_rows")
  - add
  - starts_with("as_tidyplot")
  - starts_with("flip_plot")
  - starts_with("format_")
- title: Data
- contents:
  - starts_with("animals")
  - starts_with("climate")
  - starts_with("dinosaurs")
  - starts_with("distributions")
  - starts_with("energy")
  - starts_with("eu_countries")
  - starts_with("gene")
  - starts_with("spendings")
  - starts_with("study")
  - starts_with("time")