check_time_series: Check the new time series

Description Usage Arguments Value Examples

View source: R/checking.R

Description

check_time_series examines the first value in the Time column for each event. If they are equal, it will return a single value. The returned value(s) will vary depending on the interest period (if defined), message alignment (if completed), and the Adjustment parameter ('Adj') supplied to create_time_series. Optionally, the result can be output to a dataframe containing all event-level information.

Usage

1
check_time_series(data, ReturnData = FALSE)

Arguments

data

A data table object output by create_time_series.

ReturnData

A logical indicating whether to return a data table containing Start Time information for each event.

Value

The value(s) of Time (in milliseconds) at which events begin relative to the onset of the auditory stimulus.

Examples

1
2
3
4
5
6
## Not run: 
library(VWPre)
# Check the starting Time column...
check_time_series(data = dat)

## End(Not run)

VWPre documentation built on Jan. 11, 2020, 9:28 a.m.