_pkgdown.yml

url: https://geobosh.github.io/pcts

template:
  bootstrap: 5

reference:
  - title: "Overview of package pcts"
    contents:
      - "pcts-package"
  - title: "Create and manipulate periodic ts"
    contents:
      - pcts
      - nCycles
      - availStart
      - Vec
      - window
      - pcPlot
      - pcMean
      - pcApply
  - title: "Fit periodic ts models"
    contents:
      - fitPM
      - pclsdf
      - pclspiar
      - fit_trigPAR_optim
      - "num2pcpar"
      - "pcarma_acvf2model"
  - title: "Characteristics of periodic objects"
    contents:
      - allSeasons
      - "nSeasons-methods"
      - pi1ar2par
  - title: "Periodic autocorrelations and related quantities"
    contents:
      - "maxLag-methods"
      - "autocorrelations-methods"
      - "autocovariances-methods"
      - "partialAutocorrelations-methods"     
      - "partialAutocovariances-methods"      
      - "partialCoefficients-methods"         
      - "partialVariances-methods"            
      - "backwardPartialCoefficients-methods"
      - "backwardPartialVariances-methods"    
      - "pc_sdfactor"
  - title: "Tests and asymptotics"
    contents:
      - pcTest
      - test_piar      
      - "pwn_McLeodLjungBox_test"
      - "periodic_acf1_test"
      - "meanvarcheck"
      - "parcovmatlist"
      - "pcacf_pwn_var"
  - title: "Simulation"
    contents:
      - sim_pwn
      - sim_pc
      - sim_parCoef
      - sim_parAcvf
  - title: Datasets
    contents:
      - dataFranses1996
      - Fraser2017
      - four_stocks_since2016_01_01
      - pcts_exdata
  - title: "Time series classes"
    contents:
      - "PeriodicTS-class"
      - "PeriodicMTS-class"
      - "PeriodicTS_ts-class"
      - "PeriodicMTS_ts-class"
      - "PeriodicTS_zooreg-class"
      - "PeriodicMTS_zooreg-class"
      - "PeriodicTimeSeries-class"
      - "zoo-class"
      - "zooreg-class"
  - title: "Cycle classes"
    desc: >
      Classes for representation of a time interval (cycle),
      split into smaller units of time (seasons),
      e.g. year/months, week/weekdays.
    contents:
      - "BuiltinCycle"
      - "BareCycle-class"
      - "BasicCycle-class"
      - "BuiltinCycle-class"
      - "PartialCycle-class"
      - "SimpleCycle-class"
      - "pcCycle-methods"
      - "modelCycle"
      - "unitCycle-methods"
      - "unitCycle<--methods"
      - "seqSeasons-methods"
  - title: "Datetimes and dates"
    desc: >
      A cyclic object represent a single time point with associated Cycle.
      The functions in this section provide conversions from/to calendar datetimes.
    contents:
      - "Cyclic-class"
      - "Cyclic"
      - "Pctime"
      - "as_date-methods"
      - "as_datetime-methods"
      - "date<--methods"
  - title: "Periodic filtering"
    contents:
      - "pc.filter"
      - "pc.filter.xarma"
  - title: "Periodic AR computations"
    contents:
      - "pcAR2acf"
      - "pdSafeParOrder"
      - "permean2intercept"
      - "pcacfMat"
      - "pcalg1"
      - "pcalg1util"
      - "pcAr.ss"
  - title: "Periodic ARMA computations"
    contents:
      - "pcarma_solve"
      - "pc.hat.h"
      - "pcarma_unvec"
  - title: Classes
    contents:
      - "FittedPeriodicArModel-class"
      - "FittedPeriodicArmaModel-class"
      - "ModelCycleSpec-class"
      - "PartialPeriodicAutocorrelations-class"
      - "PeriodicArModel-class"
      - "PeriodicArModel-methods"
      - "PeriodicArmaFilter-class"
      - "PeriodicArmaModel-class"
      - "PeriodicArmaSpec-class"
      - "PeriodicAutocorrelations-class"
      - "PeriodicAutocovariances-class"
      - "PeriodicBJFilter-class"
      - "PeriodicFilterModel-class"
      - "PeriodicIntegratedArmaSpec-class"
      - "PeriodicInterceptSpec-class"
      - "PeriodicMaModel-class"
      - "PeriodicSPFilter-class"
      - "PeriodicVector-class"
      - "PiPeriodicArModel-class"
      - "PiPeriodicArmaModel-class"
      - "PiPeriodicMaModel-class"
      - "SamplePeriodicAutocorrelations-class"
      - "SamplePeriodicAutocovariances-class"
      - "SiPeriodicArModel-class"
      - "SiPeriodicArmaModel-class"
      - "SiPeriodicMaModel-class"
      - "SubsetPM-class"
  - title: "Multi-companion form"
    contents:
      - "permodelmf"
      - "mC.ss"
  - title: Other
    contents:
      - "sigmaSq-methods"
      - "ex1f"
      - "filterCoef-methods"
      - "sl_utils"
      - "pcts-deprecated"
      - "[-methods"
      - "[<--methods"
      - "[[-methods"
      - "$-methods"