IsInPeriod: [internal] Returns a logical vector indicating which of the...

Description Usage Arguments Value Note

View source: R/isinperiod.R

Description

[internal] Returns a logical vector indicating which of the rows are in the specified period(s).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
IsInPeriod(obj, periods)

## S3 method for class 'TBRAnalysisData'
IsInPeriod(obj, periods)

## S3 method for class 'TBRAnalysisFitTbr1'
IsInPeriod(obj, periods)

## S3 method for class 'TBRROASAnalysisFit'
IsInPeriod(obj, periods)

## S3 method for class 'TBRQuantiles'
IsInPeriod(obj, periods)

Arguments

obj

some object.

periods

names of the periods.

Value

A logical vector of length nrow(obj), TRUE for a row that is within the given period(s), FALSE otherwise. No NAs.

Note

TBRROASAnalysisFit consists of simulations with rows only for the prediction period, not for the preanalysis period.

TBRQuantiles consists of simulations with rows only for the prediction period, not for the preanalysis period.


google/GeoexperimentsResearch documentation built on May 17, 2019, 7:42 a.m.