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

deploy:
  install_metadata: true

template:
  bootstrap: 5
  
search:
  exclude: ['news/index.html']

reference:
  - title: "Overview of package timeSeries"
    contents:
      - "timeSeries-package"
      - TimeSeriesData
  - title: "Create 'timeSeries' objects"
    contents:
      - timeSeries
      - readSeries
      - dummyMonthlySeries
      - dummyDailySeries
      - as.timeSeries
      - as.matrix.timeSeries
      - as.ts.timeSeries
      - as.data.frame.timeSeries
  - title: "Explore 'timeSeries' objects"
    contents:
      - plot
      - "lines,timeSeries-method"
      - "points,timeSeries-method"
      - pretty.timeSeries
      - "print.timeSeries"
      - str
      - is.timeSeries
      - is.signalSeries
      - isUnivariate
      - isMultivariate
      - isDaily.timeSeries
      - isMonthly.timeSeries
      - isQuarterly.timeSeries
      - isRegular
      - "is.na"
      - "is.unsorted,timeSeries-method"
  - title: "Subset 'timeSeries' objects"
    desc: >
      There are 'timeSeries' methods for subsetting operators, like '[' and
      '[<-', as well as functions and methods which broadly perform some kind of
      subsetting.
    contents:
      - window
      - TimeSeriesSubsettings
      - na.contiguous
      - na.omit
      - removeNA
      - substituteNA
      - interpNA
      - endOfPeriodSeries
      - endOfPeriodStats
      - endOfPeriodBenchmarks
  - title: "Aggregate and smooth 'timeSeries' objects"
    contents:
      - filter
      - smoothLowess
      - smoothSpline
      - smoothSupsmu
      - aggregate
      - align
      - alignDailySeries
      - daily2monthly
      - daily2weekly
      - fapply
      - applySeries
      - rollDailySeries
      - rollMonthlySeries
      - countMonthlyRecords
      - rollMonthlyWindows
  - title: "Manipulate 'timeSeries' objects"
    contents:
      - series
      - "series<-"
      - getFinCenter
      - "setFinCenter<-"
      - finCenter
      - "`finCenter<-`"
      - time
      - "time<-"
      - getUnits
      - "setUnits<-"
      - start
      - end
      - getAttributes
      - "setAttributes<-"
      - comment
      - "`comment<-`"
      - orderColnames
      - sortColnames
      - sampleColnames
      - statsColnames
      - pcaColnames
      - hclustColnames
  - title: "Transform 'timeSeries' objects"
    contents:
      - scale
      - diff
      - colCum
      - colCummaxs
      - colCummins
      - colCumprods
      - colCumreturns
      - colCumsums
      - rowCumsums
      - lag
      - sort
      - rev
      - runlengths
      - durations
      - rank
      - sample
      - math
  - title: "Financial computations on 'timeSeries' objects"
    contents:
      - returns
      - returns0
      - cumulated
      - drawdowns
      - drawdownsStats
      - splits
      - spreads
      - midquotes
      - midquoteSeries
      - spreadSeries
      - index2wealth
  - title: "Compute statistics on timeSeries objects"
    contents:
      - "cov-methods"
      - "cor-methods"
      - colStats
      - colSds
      - colVars
      - colSkewness
      - colKurtosis
      - colMaxs
      - colMins
      - colProds
      - colQuantiles
      - turns
      - turnsStats
      - orderStatistics
      - rollStats
      - rollMean
      - rollMin
      - rollMax
      - rollMedian
  - title: "Combine time series"
    contents:
      - cbind
      - rbind
      - cbind2
      - rbind2
      - merge
  - title: "Mathematical operations on 'timeSeries'"
    contents:
      - math
      - t
  - title: "Other"
    contents:
      - "timeSeries-class"
      - dimnames
      - "DataPart,timeSeries-method"
      - description
      - attach
      - internals
