reported_observations: Applies multiple recording procedures to a behavior stream

Description Usage Arguments Details Value Examples

View source: R/observation_method_filters.R

Description

This is a convenience function that allows multiple recording procedures to be applied to a single behavior stream. Results are reported either per behavior stream or as summary statistics, averaged over multiple behavior streams.

Usage

1
2
3
4
5
6
7
reported_observations(
  BS,
  data_types = c("C", "M", "E", "P", "W"),
  interval_length = 1,
  rest_length = 0,
  n_aggregate = 1
)

Arguments

BS

object of class behavior_stream

data_types

list of recording procedures to apply to the behavior stream. See details.

interval_length

time length of each interval used to score momentary time recording and interval recording procedures.

rest_length

portion of each interval to exclude from observation for interval recording. See documentation for interval_recording.

n_aggregate

number of observations over which to calculate summary statistics.

Details

The following recording procedures are currently implemented

Value

If n_aggregate = 1, a data frame with one column per procedure listed in data_types and length equal to the number of behavior streams in BS. If n_aggregate > 1, a list containing two data frames: one with sample means and one with sample variances, both taken across n_aggregate behavior streams.

Examples

1
2
3
4
BS <- r_behavior_stream(n = 50, mu = 3, lambda = 10, 
                       F_event = F_exp(), F_interim = F_exp(), stream_length = 100)
reported_observations(BS, interval_length = 10)
reported_observations(BS, interval_length = 10, n_aggregate = 5)

ARPobservation documentation built on May 1, 2021, 1:08 a.m.