.. _vignettes:

Vignettes
=========

These vignettes demonstrate how to use FlexEval.

.. toctree::
   :maxdepth: 2
   :caption: Vignettes:

   generated/vignettes/basic
   generated/vignettes/basic_rubric
   generated/vignettes/custom_rubric
   generated/vignettes/basic_cli
   generated/vignettes/metric_analysis
   

What are *vignettes*?
A `vignette <https://r-pkgs.org/vignettes.html>`__ is "a long-form guide to your package" that is common in the R community. 
Vignettes allow us to show the kinds of problems that FlexEval is designed to solve.
You can also view the vignettes `on GitHub <https://github.com/DigitalHarborFoundation/FlexEval/tree/main/vignettes>`__.