_pkgdown.yml

url: https://fastcpd.xingchi.li

template:
  bootstrap: 5
  bslib:
    base_font:
      { google: { family: "Source Sans Pro", wght: [400, 600], ital: [0, 1] } }
    code_font: { google: "Source Code Pro" }
    font_scale: 1.2
    primary: "#447099"

reference:
  - title: Main function
    desc: >
      All implementation of fastcpd is unified into one single function
      `fastcpd()`.
    contents:
      - fastcpd

  - title: Wrapper functions
    desc: >
      Simplified functions are provided for each family.

  - subtitle: Time series
    desc: >
      `fastcpd_ts()` and `fastcpd.ts()` are the main functions for time series
      data (also wrapper functions of `fastcpd()`).
    contents:
      - fastcpd.ar
      - fastcpd.arima
      - fastcpd.arma
      - fastcpd.garch
      - fastcpd.ts
      - fastcpd.var

  - subtitle: Unlabeled data
    desc: >
      Used for data without response variables, for example, mean change and
      variance change.
    contents:
      - fastcpd.mean
      - fastcpd.variance
      - fastcpd.meanvariance

  - subtitle: Regression data
    desc: >
      Detect change points in the coefficients of regression-type data.
    contents:
      - fastcpd.binomial
      - fastcpd.lasso
      - fastcpd.lm
      - fastcpd.poisson

  - title: Utility functions
    desc: >
      The following functions help with visualization and analyzation of the
      data.

  - subtitle: Variance estimation
    contents:
      - variance.arma
      - variance.lm
      - variance.mean
      - variance.median

  - subtitle: Class methods
    contents:
      - plot.fastcpd
      - print.fastcpd
      - show.fastcpd
      - summary.fastcpd

  - title: Data
    desc: >
      fastcpd comes with a selection of built-in datasets that are used in
      examples to illustrate various change point detection challenges.
    contents:
    - bitcoin
    - occupancy
    - transcriptome
    - uk_seatbelts
    - well_log

  - title: Main class
    desc: >
      The results of `fastcpd()` will be stored in the class `fastcpd` with
      accompanied several utility functions.
    contents:
      - fastcpd-class

articles:
- title: Examples
  navbar: ~
  contents:
  - examples-advanced
  - examples-custom-model

- title: Comparison
  navbar: Comparison
  contents:
  - comparison-packages
  - comparison-pelt

authors:
  Xingchi Li:
    href: https://www.xingchi.li
  Xianyang Zhang:
    href: https://zhangxiany-tamu.github.io