ERTMonFilterEventRecords: Filtering of event records.

Description Usage Arguments Details Value

View source: R/ERTMon.R

Description

Filters event records for specified min and max observation times and/or entity ID's and/or location ID's and/or variable names.

Usage

1
2
3
4
5
6
7
8
ERTMonFilterEventRecords(
  ertObj,
  minObservationTime = NULL,
  maxObservationTime = NULL,
  entityIDs = NULL,
  locationIDs = NULL,
  variables = NULL
)

Arguments

ertObj

An ERTMon object.

entityIDs

A character vector with entity ID's. If NULL no filtering over entity ID's is done.

locationIDs

A character vector with location ID's. If NULL no filtering over location ID's is done.

variables

A character vector with variable names. If NULL no filtering over variables is done.

minObservatonTime

Minimum observation time. It can be NULL, an integer value (seconds), "MinTime", or "MaxMinTime".

maxObservatonTime

Minimum observation time. NULL has the same effect as "MinTime" – no filtering. It can be NULL, an integer value (seconds), "MaxTime", or "MinMaxTime". NULL has the same effect as "MaxTime" – no filtering.

Details

The primary reason for this function is to assure the user that all events adhere to certain explicitly postulated predicates. "MaxMinTime" means that for each variable-and-entity pair is found the min observation time. The found the min-max-times and max-min-times are assigned to ertObj$SummarisedObservationTimes.

Value

An ERTMon object.


antononcube/ERTMon-R documentation built on Oct. 14, 2021, 2:27 p.m.