_pkgdown.yml

template:
  params:
    bootswatch: flatly

navbar:
  structure:
    left:
    - home
    - intro
    - reference
    - articles
    right:
    - news
    - github
    - twitter
  components:
    home:
      icon: fa-home fa-lg
      href: index.html
    reference:
      text: Reference
      href: reference/index.html
    articles:
      text: Vignettes
      menu:
      - text: Statistical Test Plotting with 'ggasym'
        href: articles/ggasym-stats.html
      - text: Using 'ggasym' with 'corrr' for Studying Correlations
        href: articles/ggasym-corrr.html
    news:
      text: Versions
      href: news/index.html
    github:
      icon: fab fa-github fa-lg
      href: https://github.com/jhrcook/ggasym
    twitter:
      icon: fab fa-twitter fa-lg
      href: https://twitter.com/JoshDoesa

reference:
- title: Geom
  desc: >
    This is the geom introduced by the ggasym package to plot two fill values
    in a symmetric matrix.
  contents:
  - '`geom_asymmat`'
  - '`GeomAsymmat`'
  - '`ggasym`'
  - '`asymmetrize`'

- title: Fill gradients
  desc: >
    Use these functions to declare the fill gradients for the top-left and
    bottom-right triangles of the matrix.
  contents:
  - '`scale_gradient`'
  - '`continuous_scale_asym`'

- title: Stats
  desc: >
    For preparing the results of statistical tests for `geom_asymmat`
  contents:
  - '`asymmetrise_stats`'
  - '`prepare_data`'

- title: Utilities
  desc: >
    These are functions that are not likely to present any use to the user and
    may be removed without notice (ie. are experimental)
  contents:
  - '`add_missing_combinations`'
  - '`bind_missing_combs`'
  - '`factor_is_greater`'
  - '`get_other_combs`'
  - '`is_grouped`'
  - '`make_fill_df`'
  - '`organize_levels`'
  - '`swap_cols`'
  - '`which_level`'


articles:
- title: Statistical Test Plotting
  desc: >
    An example of using the `asymmetrise_stats` wrapper for preparing the
    results of a statistical test for `geom_asymmat`
  contents:
  - '`ggasym-stats`'
- title: Studying Correlations
  desc: >
    Using 'ggasym' with the 'corrr' package to study the different correlation
    methods.
  contents:
  - '`ggasym-corrr`'