ds_options: Determine downsampling options based on current sampling rate

Description Usage Arguments Value Examples

View source: R/checking.R

Description

ds_options determines the possible rates to which the current sampling rate can downsampled. It then prints the options in both bin size (milliseconds) and corresponding sampling rate (Hertz).

Usage

1
ds_options(SamplingRate, OutputRates = "Suggested")

Arguments

SamplingRate

A positive integer indicating the sampling rate (in Hertz) used to record the gaze data, which can be determined with the function check_samplingrate.

OutputRates

A string ("Suggested" or "All") controlling if all rates are output, or if only whole rates (default) are output.

Value

A printed summary of options (bin size and rate) for downsampling.

Examples

1
2
3
4
5
6
## Not run: 
library(VWPre)
# Determine downsampling options...
ds_options(SamplingRate = 1000)

## End(Not run)

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