tk_zooreg_dispatch_: S3 methods for zooreg method dispatch

View source: R/coersion-tk_zooreg.R

tk_zooreg_dispatch_R Documentation

S3 methods for zooreg method dispatch

Description

Method dispatch for Zooreg

Usage

tk_zooreg_dispatch_(
  data,
  select,
  date_var,
  start,
  end,
  frequency,
  deltat,
  ts.eps,
  order.by,
  silent
)

tk_zooreg_.data.frame(
  data,
  select,
  date_var,
  start,
  end,
  frequency,
  deltat,
  ts.eps,
  order.by,
  silent
)

tk_zooreg_.default(
  data,
  select,
  date_var,
  start,
  end,
  frequency,
  deltat,
  ts.eps,
  order.by,
  silent
)

Arguments

data

A time-based tibble or time-series object.

select

Applicable to tibbles and data frames only. The column or set of columns to be coerced to zooreg class.

date_var

Applicable to tibbles and data frames only. Column name to be used to order.by. NULL by default. If NULL, function will find the date or date-time column.

start

the time of the first observation. Either a single number or a vector of two integers, which specify a natural time unit and a (1-based) number of samples into the time unit.

end

the time of the last observation, specified in the same way as start.

frequency

the number of observations per unit of time.

deltat

the fraction of the sampling period between successive observations; e.g., 1/12 for monthly data. Only one of frequency or deltat should be provided.

ts.eps

time series comparison tolerance. Frequencies are considered equal if their absolute difference is less than ts.eps.

order.by

a vector by which the observations in x are ordered. If this is specified the arguments start and end are ignored and zoo(data, order.by, frequency) is called. See zoo for more information.

silent

Used to toggle printing of messages and warnings.

Value

A character vector


timetk documentation built on Nov. 2, 2023, 6:18 p.m.