_pkgdown.yml

url: https://koenderks.github.io/jfa/

destination: "."

authors:
  Koen Derks:
    href: https://koenderks.com

template:
  params:
    bootswatch: cosmo

navbar:
  left:
    - icon: fa-home fa-lg
      href: index.html
    - text: Get started
      href: articles/jfa.html
    - text: Vignettes
      href: articles/index.html
    - text: Functions
      href: reference/index.html
    - text: News
      href: news/index.html
  right:
   - icon: fa-github
     href: https://github.com/koenderks/jfa
   - icon: fa-users
     href: https://github.com/koenderks/jfa/discussions

home:
  links:
  - text: Ask a question
    href: https://github.com/koenderks/jfa/discussions

articles:
  - title: Audit Sampling
    desc: >
      These vignettes provide an introduction to planning, selecting, and
      evaluating an audit sample compliant with international standards on
      auditing using the **jfa** package.
    contents:
      - articles/audit-sampling
      - articles/creating-prior
      - articles/sample-planning
      - articles/sample-selection
      - articles/sample-evaluation
      - articles/sample-evaluation-partial
      - articles/sampling-workflow
      - articles/bayesian-sampling-workflow
  - title: Data Auditing
    desc: >
      These vignettes provide an introduction to data auditing using the **jfa**
      package.
    contents:
      - articles/data-auditing
      - articles/digit-analysis
  - title: Algorithm Auditing
    desc: >
      These vignettes provide an introduction to algorithm auditing using the **jfa**
      package.
    contents:
      - articles/algorithm-auditing
      - articles/model-fairness

reference:
  - title: Overview
    desc: >
      Package overview
    contents:
      - jfa-package
  - title: Audit sampling
    desc: >
      Functions for planning, selecting, and evaluating audit samples compliant
      with international standards on auditing.
    contents:
      - auditPrior
      - planning
      - selection
      - evaluation
  - title: Data auditing
    desc: >
      Functions for data auditing, such as testing the distribution of leading
      digits in a data set against Benford's law, and assessing repeated values.
    contents:
      - digit_test
      - repeated_test
  - title: Algorithm auditing
    desc: >
      Functions for auditing the output of algorithms with respect to fairness.
    contents:
      - fairness_selection
      - model_fairness
  - title: Data sets
    desc: >
      Example data sets included in the **jfa** package.
    contents:
      - accounts
      - allowances
      - benchmark
      - BuildIt
      - carrier
      - compas
      - retailer
      - sanitizer
      - sinoForest
  - title: Miscellaneous
    desc: >
      Functions for working with output from the **jfa** package.
    contents:
      - jfa-methods