event_model.formula: event_model.formula

View source: R/event_model.R

event_model.formulaR Documentation

event_model.formula

Description

This function constructs an event model using a formula x, a dataset data, a block variable, and other parameters like sampling frame, drop_empty, durations, and precision. It is specifically designed to handle models specified as formulas.

Usage

## S3 method for class 'formula'
event_model(
  x,
  data,
  block,
  sampling_frame,
  drop_empty = TRUE,
  durations = 0,
  precision = 0.3,
  ...
)

Arguments

x

A formula specifying the event model.

data

The dataset containing the event information.

block

The block variable, either a formula or a vector of block values.

sampling_frame

The time series grid over which to sample the function.

drop_empty

Logical indicating whether to drop empty events. Default is TRUE.

durations

A numeric vector of event durations. Default is 0 for all events.

precision

Numeric value indicating the precision of the model. Default is 0.3.

...

Additional arguments.

Details

Construct an event model from a formula and data.

Value

An event model object.


bbuchsbaum/fmrireg documentation built on May 16, 2023, 10:56 a.m.