summary.eventdata: Summarise event data

Description Usage Arguments Details Value Author(s)

View source: R/events.R

Description

Summarises a set of event data

Usage

1
2
## S3 method for class 'eventdata'
summary(object, ...)

Arguments

object

Event data object

...

Not used

Details

This is a compact summary of an event data object. For more detail consult the object itself. Currently it is simply a data.frame with conventionally named column names, but that almost certainly will change to deal with larger datasets in later package versions. If your code uses the package's accessor functions then you won't feel a thing when this happens.

Value

A short description of the event data

Author(s)

Will Lowe


conjugateprior/events documentation built on May 13, 2019, 9:56 p.m.