_pkgdown.yml

url: https://loelschlaeger.github.io/fHMM/

home:
  title: Fit hidden Markov models to financial data

authors:
  Lennart Oelschläger:
    href: https://loelschlaeger.de
  Timo Adam:
    href: https://timoadam.github.io/
  Rouven Michels:
    href: https://ekvv.uni-bielefeld.de/pers_publ/publ/PersonDetail.jsp?personId=241029889

template:
  bootstrap: 5
  bslib:
    primary: "#0054AD"
    border-radius: 0.5rem
    btn-border-radius: 0.25rem

reference:
- title: Data preparation
  desc: Use these functions to prepare or simulate financial data.
  contents:
  - set_controls
  - download_data
  - prepare_data
  - fHMM_parameters
  - plot.fHMM_data
- title: Model estimation
  desc: Use these function for model estimation and state decoding.
  contents:
  - fit_model
  - decode_states
  - reorder_states
- title: Model evaluation
  desc: Use these functions to evaluate a fitted model.
  contents:
  - coef.fHMM_model
  - compare_models
  - compute_residuals
  - plot.fHMM_model
  - fHMM_colors
  - fHMM_events
  - predict.fHMM_model
- title: Models
  desc: The following pre-computed models are included in the package.
  contents:
  - has_keyword("model")
- title: Small utilities
  desc: These functions may be useful beyond {fHMM}.
  contents:
  - has_keyword("utils")
- title: internal
  desc: These functions are not user-level.
  contents:
  - has_keyword("internal")