.. FPL documentation master file, created by
   sphinx-quickstart on Mon May 22 12:39:06 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=================================
Metrics FPL Guide
=================================

Metrics FPL is a programming language designed to statisticaly analyze and manipulate metrics and API data records.

.. contents:: This user manual is divided into the following chapters:

Tutorial
^^^^^^^^

A Basic Tutorial for the Language

This sub-section presents a basic overview of the language. The goal is to present a quick guide using examples for the user to get started. In addition, some key concepts necessary to understand and use the language are explored.

Visit the [Tutorial](/chapters/tutorial/) chapter.

MetricsFPL Concepts
^^^^^^^^^^^^^^^^^^^

An overview of concepts for the Language

Visit the [FPL Concepts](/chapters/concepts/) chapter.

Data Selection
^^^^^^^^^^^^^^

How to *select* or *load* the **event** (log) and **resources**  data for input into a the FPL block

Visit the [Data Selection](/chapters/data-selection/) chapter.

Data Extraction
^^^^^^^^^^^^^^^

How to extract the raw data from search/load into workable table columns

Visit the [Data Extraction](/chapters/data-extraction/) chapter.

Data Processing
^^^^^^^^^^^^^^^

How to manipulate these column data into more useful statistics

Visit the [Data Processing](/chapters/data-processing/) chapter.

Table Functions
"""""""""""""""

Advanced data manipulation with multiple columns in tables

Lookup Functions
""""""""""""""""

Add or reference data from external data sources from within FPL

Utility Function
""""""""""""""""

Utility functions for data formatting / parsing / processing

Runtime Arguments
^^^^^^^^^^^^^^^^^

How to define / execute FPL using custom values at run time

Visit the [Runtime Arguments](/chapters/arguments/) chapter.

Examples
^^^^^^^^

Working examples of FPL searches can be found throughout this site.

See [Examples](/chapters/examples/) here.

> Page last updated: 2023 May 25

.. toctree::
   :maxdepth: 3
   :caption: Getting started

   FPL Tutorial <chapters/tutorial>
   Concepts <chapters/concepts>

.. toctree::
   :maxdepth: 2
   :caption: Chapters

   Data Selection <chapters/data-selection>
   Data Extraction <chapters/data-extraction>
   Data Processing <chapters/data-processing>
   Runtime Arguments <chapters/arguments>
   FPL Reports <chapters/reports>
   Examples <chapters/examples>
   chapters/placeholder

.. toctree::
   :maxdepth: 3
   :caption: Scratchpad

   demo
   demo2