_pkgdown.yml

url: https://feasts.tidyverts.org

template:
  params:
    bootswatch: cosmo
  includes:
    in_header: |
      <script defer data-domain="feasts.tidyverts.org" src="https://track.mitchelloharawild.com/js/plausible.js"></script>

development:
  mode: auto

authors:
  Mitchell O'Hara-Wild:
    href: https://mitchelloharawild.com
  Rob Hyndman:
    href: http://robjhyndman.com
  Earo Wang:
    href: https://earo.me

navbar:
  type: default
  left:
  - text: Introduction
    href: articles/feasts.html
  - text: Reference
    href: reference/index.html
  - text: Changelog
    href: news/index.html
#  - text: Vignettes
#    menu:
#    - text: Introduction to feasts
#      href: articles/feasts.html
  - text: News
    menu:
    - text: "Release notes"
    - text: "Version 0.1.0"
      href: https://www.mitchelloharawild.com/blog/feasts/
    - text: "Change log"
      href: news/index.html
  right:
  - icon: fa-github fa-lg
    href: https://github.com/tidyverts/feasts

reference:
- title: Overview
  contents:
    - feasts-package
- title: Graphics
  desc: >
    Visualisation is often the first step in understanding the patterns in time series data.
    The package uses [ggplot2](https://ggplot2.tidyverse.org/) to produce customisable graphics to visualise time series patterns.
  contents:
    - autoplot.tbl_cf
    - gg_season
    - gg_subseries
    - gg_tsdisplay
    - gg_tsresiduals
    - gg_lag
    - gg_arma
    - gg_irf

- title: Decompositions
  desc: >
    Useful for decomposing a time series into some simpler structural components.
  contents:
    - classical_decomposition
    - STL
    - generate.stl_decomposition
    - X_13ARIMA_SEATS

- title: Autocorrelation analysis
  desc: >
    Identify autocorrelations in the data.
  contents:
    - ACF
    - PACF
    - CCF
    - feat_acf
    - feat_pacf

- title: Unit root tests
  desc: >
    Unit root tests for use with [`fabletools::features()`](https://fabletools.tidyverts.org/reference/features.html).
  contents:
    - unitroot_kpss
    - unitroot_pp
    - unitroot_ndiffs
    - unitroot_nsdiffs

- title: Portmanteau tests
  desc: >
    Statistical tests for examining the null hypothesis of independence in a given time series.
  contents:
    - portmanteau_tests
    - box_pierce
    - ljung_box

- title: Cointegration tests
  desc: >
    Statistical tests for investigating cointegration between time series.
  contents:
    - cointegration_johansen
    - cointegration_phillips_ouliaris

- title: Tiling window features
  desc: >
    Computes feature of a time series based on tiled (non-overlapping) windows.
  contents:
    - var_tiled_var
    - var_tiled_mean

- title: Sliding window features
  desc: >
    Computes feature of a time series based on sliding (overlapping) windows.
  contents:
    - shift_level_max
    - shift_var_max
    - shift_kl_max

- title: Other features
  desc: >
    Uncategorised features
  contents:
    - feat_stl
    - feat_spectral
    - feat_intermittent
    - stat_arch_lm
    - n_crossing_points
    - n_flat_spots
    - coef_hurst
    - guerrero