as_events: Coerce to an Event Table

In ezwelty/linbin: Binning and Plotting of Linearly Referenced Data

Coerce to an Event Table

Description

Attempts to coerce an object to an event table.

Usage

as_events(x, ...)

## S3 method for class 'numeric'
as_events(x, ...)

## S3 method for class 'POSIXt'
as_events(x, ...)

## S3 method for class 'Date'
as_events(x, ...)

## S3 method for class 'matrix'
as_events(x, from.col = 1, to.col = NULL, ...)

## S3 method for class 'data.frame'
as_events(x, from.col = 1, to.col = NULL, ...)

Arguments

x	Object to be coerced to an event table.
...	Additional arguments passed to or used by methods.
from.col, to.col	Names or indices of the columns in x containing the event endpoints. Values are swapped as needed to ensure that to > or = from on all rows. If NULL, to.col defaults to from.col + 1 (if column exists) or from.col.

Methods (by class)

• numeric: Expands a numeric vector into two columns of event endpoints.

• POSIXt: Coerces to numeric before dispatching.

• Date: Coerces to numeric before dispatching.

• matrix: Converts the matrix to a data frame, then calls the data.frame method.

• data.frame: Renames from.col and to.col to "from" and "to" as needed. Since these column names must be unique, other columns cannot also be called "from" or "to".

See Also

events for creating event tables and read_events for reading files as event tables.

Examples

as_events(1)
as_events(1:5)
as_events(cbind(1:5, 1:5), 1, 2)
as_events(data.frame(x = 1, start = 1:5, stop = 1:5), "start", "stop")

ezwelty/linbin documentation built on April 19, 2023, 8:41 a.m.